#ifndef _QCMAP_CLIENT_H_ #define _QCMAP_CLIENT_H_ /*====*====*====*====*====*====*====*====*====*====*====*====*====*====*====* _ Q C M A P _ C L I E N T . H *====*====*====*====*====*====*====*====*====*====*====*====*====*====*====*/ /** @file QCMAP_Client.h @brief QCMAP Client public function declarations. */ /*=========================================================================== NOTE: The @brief description above does not appear in the PDF. The description that displays in the PDF is maintained in the xxx_mainpage.dox file. Contact Tech Pubs for assistance. ===========================================================================*/ /*=========================================================================== FILE: QCMAP_Client.h SERVICES: QCMAP Client Class ===========================================================================*/ /*=========================================================================== Copyright (c) 2012-2017 Qualcomm Technologies, Inc. All rights reserved. Confidential and Proprietary - Qualcomm Technologies, Inc. ===========================================================================*/ /*=========================================================================== EDIT HISTORY FOR MODULE Please notice that the changes are listed in reverse chronological order. when who what, where, why -------- --- ------------------------------------------------------- 08/29/16 leo (Tech Pubs) Edited/added Doxygen comments and markup. 05/28/15 kl (Tech Pubs) Edited/added Doxygen comments and markup. 01/05/15 rk qtimap off-target support. 10/20/14 kl (Tech Pubs) Edited/added Doxygen comments and markup. 07/11/12 gk Created module. 10/26/12 cp Added support for Dual AP and different types of NAT. 02/27/13 cp Added support to get IPV6 WAN status. 04/17/13 mp Added support to get IPv6 WWAN/STA mode configuration. 06/12/13 sg Added support for DHCP Reservation 01/11/14 sr Added support for connected devices information in SoftAP 02/24/14 vm Changes to Enable/Disable Station Mode to be in accordance with IoE 9x15 ===========================================================================*/ /* group: qcmap */ #ifdef FEATURE_QTIMAP_OFFTARGET #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "stringl.h" #include "ds_util.h" #include "comdef.h" #include "qualcomm_mobile_access_point_msgr_v01.h" #include "qcmap_client_util.h" #ifdef FEATURE_QTIMAP_OFFTARGET #include #endif #ifdef USE_GLIB #include #define strlcpy g_strlcpy #define strlcat g_strlcat #endif /** @addtogroup qcmap_constants @{ */ /** Maximum size of the file. */ #define QCMAP_MSGR_MAX_FILE_PATH_LEN 100 /** Minimum IPA Initial Packet Threshold*/ #define SW_PACKET_THRESHOLD 3 /** Maximum port value. */ #define MAX_PORT_VALUE 65535 /** Maximum valid protocol value. */ #define MAX_PROTO_VALUE 255 /** Maximum valid Type of Service (TOS) value. */ #define MAX_TOS_VALUE 255 /** Macro for Enable Packet stats */ #define PACKET_STATS_ENABLE 1 /** Macro for Disable Packet stats */ #define PACKET_STATS_DISABLE 0 /** Macro for Reset Packet stats data */ #define PACKET_STATS_RESET 5 /** @} */ /* end_addtogroup qcmap_constants */ #ifdef __cplusplus extern "C" { #endif #include "qmi_client.h" #ifdef __cplusplus } #endif #ifdef FEATURE_QTIMAP_OFFTARGET #undef LOG_MSG_INFO1 #define LOG_MSG_INFO1(fmtString, x, y, z) \ { \ if ( x != 0 && y !=0 && z != 0) \ fprintf(stderr, "\nINFO1:"fmtString"\n", x, y, z); \ else if ( x != 0 && y != 0) \ fprintf(stderr, "\nINFO1:"fmtString"\n", x, y); \ else if ( x != 0) \ fprintf(stderr, "\nINFO1:"fmtString"\n", x); \ else \ fprintf(stderr, "\nINFO1:"fmtString"\n"); \ } #undef LOG_MSG_INFO2 #define LOG_MSG_INFO2(fmtString, x, y, z) \ { \ if ( x != 0 && y !=0 && z != 0) \ fprintf(stderr, "\nINFO1:"fmtString"\n", x, y, z); \ else if ( x != 0 && y != 0) \ fprintf(stderr, "\nINFO1:"fmtString"\n", x, y); \ else if ( x != 0) \ fprintf(stderr, "\nINFO1:"fmtString"\n", x); \ else \ fprintf(stderr, "\nINFO1:"fmtString"\n"); \ } #undef LOG_MSG_INFO3 #define LOG_MSG_INFO3(fmtString, x, y, z) \ { \ if ( x != 0 && y !=0 && z != 0) \ fprintf(stderr, "\nINFO3:"fmtString"\n", x, y, z); \ else if ( x != 0 && y != 0) \ fprintf(stderr, "\nINFO3:"fmtString"\n", x, y); \ else if ( x != 0) \ fprintf(stderr, "\nINFO3:"fmtString"\n", x); \ else \ fprintf(stderr, "\nINFO3:"fmtString"\n"); \ } #undef LOG_MSG_ERROR #define LOG_MSG_ERROR(fmtString, x, y, z) \ { \ if ( x != 0 && y !=0 && z != 0) \ fprintf(stderr, "\nError:"fmtString"\n", x, y, z); \ else if ( x != 0 && y != 0) \ fprintf(stderr, "\nError:"fmtString"\n", x, y); \ else if ( x != 0) \ fprintf(stderr, "\nError:"fmtString"\n", x); \ else \ fprintf(stderr, "\nError:"fmtString"\n"); \ } #else /** @addtogroup qcmap_macros @{ */ /* Log Message Macros */ /** Macro for a high-level message. */ #define LOG_MSG_INFO1_LEVEL MSG_LEGACY_HIGH /** Macro for a medium-level message. */ #define LOG_MSG_INFO2_LEVEL MSG_LEGACY_MED /** Macro for a low-level message. */ #define LOG_MSG_INFO3_LEVEL MSG_LEGACY_LOW /** Macro for a error message. */ #define LOG_MSG_ERROR_LEVEL MSG_LEGACY_ERROR /** Macro to print the log message information. */ #define PRINT_MSG( level, fmtString, x, y, z) \ MSG_SPRINTF_4( MSG_SSID_LINUX_DATA, level, "%s(): " fmtString, \ __FUNCTION__, x, y, z); /** Macro to print a high-level message. */ #define LOG_MSG_INFO1( fmtString, x, y, z) \ { \ PRINT_MSG( LOG_MSG_INFO1_LEVEL, fmtString, x, y, z); \ } /** Macro to print a medium-level message. */ #define LOG_MSG_INFO2( fmtString, x, y, z) \ { \ PRINT_MSG( LOG_MSG_INFO2_LEVEL, fmtString, x, y, z); \ } /** Macro to print a low-level message. */ #define LOG_MSG_INFO3( fmtString, x, y, z) \ { \ PRINT_MSG( LOG_MSG_INFO3_LEVEL, fmtString, x, y, z); \ } /** Macro to print an error message. */ #define LOG_MSG_ERROR( fmtString, x, y, z) \ { \ PRINT_MSG( LOG_MSG_ERROR_LEVEL, fmtString, x, y, z); \ } /** @} */ /* end_addtogroup qcmap_macros */ #endif /** @addtogroup qcmap_datatypes @{ */ /** Parameters that control QCMAP client behavior. */ typedef void (*client_status_ind_t) ( qmi_client_type user_handle, /**< QMI user handle. */ unsigned int msg_id, /**< Indicator message ID. */ void *ind_buf, /**< Raw indication data. */ unsigned int ind_buf_len, /**< Raw data length. */ void *ind_cb_data /**< User callback handle. */ ); /** Data type for IPv4 configuration. */ typedef struct { in_addr public_ip; /**< Public IP address. */ in_addr primary_dns; /**< Primary domain name service (DNS) IP address. */ in_addr secondary_dns; /**< Secondary DNS IP address. */ }v4_conf_t; /** Data type for IPv6 configuration. */ typedef struct { struct in6_addr public_ip_v6; /**< Public IPv6 address. */ struct in6_addr primary_dns_v6; /**< Primary domain name service (DNS) IPv6 address. */ struct in6_addr secondary_dns_v6; /**< Secondary DNS IPv6 address. @newpagetable */ }v6_conf_t; /** Data type for the backhaul preference. */ typedef struct { qcmap_msgr_backhaul_type_enum_v01 first; /**< First backhaul preference. */ qcmap_msgr_backhaul_type_enum_v01 second; /**< Second backhaul preference. */ qcmap_msgr_backhaul_type_enum_v01 third; /**< Third backhaul preference. */ qcmap_msgr_backhaul_type_enum_v01 fourth; /**< Fourth backhaul preference. */ qcmap_msgr_backhaul_type_enum_v01 fifth; /**< Fifth backhaul preference. */ }backhaul_pref_t; /** Data type for network configuration. */ typedef union { v4_conf_t v4_conf; /**< IPv4 configuration. */ v6_conf_t v6_conf; /**< IPv6 configuration. */ }qcmap_nw_params_t; /** SOCKSv5 configuration params */ typedef struct { qcmap_msgr_socksv5_config_file_paths_v01 config_file_paths; unsigned char auth_method; char lan_iface[QCMAP_MAX_IFACE_NAME_SIZE_V01]; qcmap_msgr_socksv5_wan_config_v01 wan_service[QCMAP_MAX_NUM_BACKHAULS_V01]; } socksv5_configuration; /** @} */ /* end_addtogroup qcmap_datatypes */ //=================================================================== // Class Definitions //=================================================================== /** @ingroup qcmap_class */ class QCMAP_Client { private: /* Profile Handle which will be used for WWAN related API's */ profile_handle_type_v01 profileHandle; public: /*=========================================================================== FUNCTION QCMAP_Client() ===========================================================================*/ /** @ingroup qcmap_class Constructor for the client library QCMAP_Client class. This constructor calls the QMI common client interface (QCCI) functions to connect with the QCMAP_MSGR service and registers the client callback function for any asynchronous indications received from the QCMAP_MSGR service. @datatypes #client_status_ind_t @param[in,out] client_cb_ind Client callback function registered with the QMI framework. @return None. */ QCMAP_Client ( client_status_ind_t client_cb_ind ); /*=========================================================================== FUNCTION QCMAP_Client clean up ===========================================================================*/ /** @ingroup qcmap_class Destructor for the client object. @return None. */ virtual ~QCMAP_Client ( void ); /* ---------------------------MobileAP Execution---------------------------*/ /*=========================================================================== FUNCTION EnableMobileAP() ===========================================================================*/ /** @ingroup qcmap_enable_mobile_ap Enables the MobileAP interface. This function enables the QCMobileAP based on the configuration provided. The server, as part of enabling the QCMobileAP, gets the appropriate dsi_netctrl module and NAS handles. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Successfully set up the dsi_netctrl module and NAS client handles. \n FALSE -- Any of the above operations failed. @dependencies None. */ boolean EnableMobileAP ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableMobileAP() ===========================================================================*/ /** @ingroup qcmap_disable_mobile_ap Disables the QCMobileAP solution. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Successfully released the handles and NAS client. \n FALSE -- Any of the above operations failed. @dependencies QCMobileAP must be enabled. */ boolean DisableMobileAP ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetWWANProfileHandlePreference() ===========================================================================*/ /** @ingroup set_wwan_profile_handle_preference This command set profile handle to be used for WWAN API's. @datatypes profile_handle_type_01\n qmi_error_type_v01\n @param[in] profile_handle Profile handle to be used for WWAN API's. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetWWANProfileHandlePreference ( profile_handle_type_v01 profile_handle, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EnableIPV4() ===========================================================================*/ /** @ingroup qcmap_enable_ipv4 This command enables IPv4 functionality. It establishes the IPv4 call using the stored network policy if autoconnect is enabled and establishes the NAT rules. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EnableIPV4 ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableIPV4() ===========================================================================*/ /** @ingroup qcmap_disable_ipv4 Disables IPv4 functionality; brings down the IPv4 call if it is already connected and disables NAT. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DisableIPV4 ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EnableIPV6() ===========================================================================*/ /** @ingroup qcmap_enable_ipv6 Enables IPv6 functionality. The IPv6 call is established using the stored network policy if autoconnect is enabled and enables IPv6 forwarding. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EnableIPV6 ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableIPV6() ===========================================================================*/ /** @ingroup qcmap_disable_ipv6 Disables IPv6 functionality; brings down the IPv6 call if it is already connected and disables IPv6 forwarding. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DisableIPV6 ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION ConnectBackHaul() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:connect_back_haul} Connects the Wireless Wide Area Network (WWAN) backhaul.This function connects the WWAN based on the configuration provided. This function calls dsi_netctrl to connect the backhaul. @datatypes qcmap_msgr_wwan_call_type_v01\n qmi_error_type_v01 @param[in] call_type Identifies call type. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean ConnectBackHaul ( qcmap_msgr_wwan_call_type_v01 call_type, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisconnectBackHaul() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:disconnect_back_haul} Disconnects the WWAN backhaul. This function calls dsi_netctrl to disconnect the backhaul. @datatypes qcmap_msgr_wwan_call_type_v01\n qmi_error_type_v01 @param[in] call_type Identifies call type. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DisconnectBackHaul ( qcmap_msgr_wwan_call_type_v01 call_type, qmi_error_type_v01 *qmi_err_num ); /** @cond */ /*=========================================================================== * FUNCTION EnableSTAMode() * ===========================================================================*/ /** @ingroup qcmap_enable_sta_mode Enables WLAN in STA-Only mode. This function is used internally by the eCNE module. Other QCMAP Clients must not use this function. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. A few important error codes are as follows:\n - QMI_ERR_NO_EFFECT_V01 -- WLAN is already enabled. \n - QMI_ERR_NONE_V01 -- Success. \n - QMI_ERR_INTERNAL_V01 -- Failure. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EnableSTAMode ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== * FUNCTION DisableSTAMode() * ===========================================================================*/ /** @ingroup qcmap_disable_sta_mode Disables WLAN in STA-Only mode. This is only to be used internally by eCNE module. Other QCMAP clients should not use this API. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. The most common error codes are: \n - QMI_ERR_NO_EFFECT_V01 -- WLAN is already enabled \n - QMI_ERR_NONE_V01 -- Success \n - QMI_ERR_INTERNAL_V01 -- Failure @return TRUE -- Success \n FALSE -- Failure @dependencies QCMobileAP must be enabled. */ boolean DisableSTAMode ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION RegisterForWLANStatusIND() ===========================================================================*/ /** @ingroup qcmap_register_for_wlan_status_ind Registers for WLAN status indications. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @param[in] register_indication Boolean value to either register or deregister for a WLAN status indication. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean RegisterForWLANStatusIND ( qmi_error_type_v01 *qmi_err_num, boolean register_indication ); /** @endcond */ /*=========================================================================== FUNCTION EnableWLAN() ===========================================================================*/ /** @ingroup qcmap_enable_wlan Enables the WLAN. This function enables the WLAN based on the hostpad configuration provided. This function inserts the WLAN kernel module and advertises the SSID. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EnableWLAN ( qmi_error_type_v01 *qmi_err_num, /** @cond */ boolean privileged_client = false /** @endcond */ ); /*=========================================================================== FUNCTION DisableWLAN() ===========================================================================*/ /** @ingroup qcmap_disable_wlan Disables the WLAN. This function removes the kernel module for the Wi-Fi driver. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DisableWLAN ( qmi_error_type_v01 *qmi_err_num, /** @cond */ boolean privileged_client = false /** @endcond */ ); /*=========================================================================== FUNCTION SetWLANConfig() ===========================================================================*/ /** @ingroup qcmap_set_wlan_config Sets the WLAN configuration: WLAN mode, guest access profile, and station mode configuration. @datatypes qcmap_msgr_wlan_mode_enum_v01 - QCMAP_MSGR_WLAN_MODE_AP_V01 \n WLAN is in AP mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_V01\n WLAN is in AP/AP Mode. -# QCMAP_MSGR_WLAN_MODE_AP_STA_V01\n WLAN is in AP/STA Mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_AP_V01\n WLAN is in AP/AP/AP Mode -# QCMAP_MSGR_WLAN_MODE_AP_AP_AP_AP_V01\n WLAN is in AP/AP/AP/AP Mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_STA_V01\n WLAN is in AP/AP/STA Mode. -# QCMAP_MSGR_WLAN_MODE_AP_STA_BRIDGE_V01\n WLAN is in AP/STA Bridge Mode.Only used for GetWLANStatus. -# QCMAP_MSGR_WLAN_MODE_AP_AP_STA_BRIDGE_V01\n WLAN is in AP/AP/STA Bridge Mode.Only used for GetWLANStatus. qcmap_msgr_access_profile_v01 - QCMAP_MSGR_PROFILE_FULL_ACCESS_V01 \n AP can access complete LAN, including the internet. - QCMAP_MSGR_PROFILE_INTERNET_ONLY_V01 \n AP can only access the internet. @par qcmap_msgr_station_mode_config_v01 -# qcmap_msgr_sta_connection_enum_v01\n Connection type.STATIC or DYNAMIC -# qcmap_msgr_sta_static_ip_config_v01\n Static IP configuration. Used only when the connection type is static. -# ap_sta_bridge_mode\n Used to Set Bridge/Router Mode when STA is active. @par qmi_error_type_v01 @par qcmap_msgr_guest_profile_config_v01 - qcmap_msgr_access_profile_v01 \n Provides an array of guest profiles. @param[in] wlan_mode WLAN mode to be set. @param[in] guest_ap_access_profile Guest AP access profile configuration. \n This parameter is for the legacy \n Single Guest AP mode. @param[in] station_config Station mode WLAN configuration. @param[out] qmi_err_num Error code returned by the server. @param[in] guest_profile Optional: Data structure pointer to set guest AP profile information. \n Must be used if more than one guest APs is configured. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetWLANConfig ( qcmap_msgr_wlan_mode_enum_v01 wlan_mode, qcmap_msgr_access_profile_v01 guest_ap_access_profile, qcmap_msgr_station_mode_config_v01 station_config, qmi_error_type_v01 *qmi_err_num, qcmap_msgr_guest_profile_config_v01 *guest_profile = NULL ); /*=========================================================================== FUNCTION GetWLANConfig() ===========================================================================*/ /** @ingroup qcmap_get_wlan_config Gets the WLAN configuration: WLAN mode, guest AP access profile, and station mode configuration. @datatypes qcmap_msgr_wlan_mode_enum_v01 - QCMAP_MSGR_WLAN_MODE_AP_V01 \n WLAN is in AP mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_V01\n WLAN is in AP/AP Mode. -# QCMAP_MSGR_WLAN_MODE_AP_STA_V01\n WLAN is in AP/STA Mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_AP_V01\n WLAN is in AP/AP/AP Mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_AP_AP_V01\n WLAN is in AP/AP/AP/AP Mode. -# QCMAP_MSGR_WLAN_MODE_AP_AP_STA_V01\n WLAN is in AP/AP/STA Mode. -# QCMAP_MSGR_WLAN_MODE_AP_STA_BRIDGE_V01\n WLAN is in AP/STA Bridge Mode.Only used for GetWLANStatus. -# QCMAP_MSGR_WLAN_MODE_AP_AP_STA_BRIDGE_V01\n WLAN is in AP/AP/STA Bridge Mode.Only used for GetWLANStatus. qcmap_msgr_access_profile_v01 - QCMAP_MSGR_PROFILE_FULL_ACCESS_V01 \n AP can access complete LAN, including the internet. - QCMAP_MSGR_PROFILE_INTERNET_ONLY_V01 \n AP can only access the internet. @par qcmap_msgr_station_mode_config_v01 -# qcmap_msgr_sta_connection_enum_v01\n Connection type.STATIC or DYNAMIC -# qcmap_msgr_sta_static_ip_config_v01\n Static IP configuration. Used only when the connection type is static. -# ap_sta_bridge_mode\n Used to Set Bridge/Router Mode when STA is active. -# qcmap_msgr_station_mode_config_v01 Station Only Mode is enabled/disabled @par qmi_error_type_v01 @par qcmap_msgr_guest_profile_config_v01 - qcmap_msgr_access_profile_v01 \n Provides an array of guest profiles. @param[out] wlan_mode WLAN mode to be set. @param[out] guest_ap_access_profile Guest AP access profile configuration. \n This parameter is for the legacy Single Guest AP mode. @param[out] station_config Station mode WLAN configuration. @param[out] qmi_err_num Error code returned by the server. @param[out] guest_profile (Optional) Data structure base pointer to obtain guest AP profile information. \n Must be used if more than one guest AP is configured. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetWLANConfig ( qcmap_msgr_wlan_mode_enum_v01 *wlan_mode, qcmap_msgr_access_profile_v01 *guest_ap_access_profile, qcmap_msgr_station_mode_config_v01 *station_config, qmi_error_type_v01 *qmi_err_num, qcmap_msgr_guest_profile_config_v01 *guest_profile = NULL ); /*=========================================================================== FUNCTION ActivateWLAN() ===========================================================================*/ /** @ingroup qcmap_activate_wlan Activates the WLAN with the latest configuration. This activation might cause the WLAN to be disabled and re-enabled depending on the changes to the configuration. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean ActivateWLAN ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetLANConfig() ===========================================================================*/ /** @ingroup qcmap_set_lan_config Sets the LAN configuration parameters like gateway IP, subnet mask and the enable DHCP flag, along with DHCP parameters. All LAN interfaces are bridged together using a bridge interface. A single instance of the DHCP server, running on the bridge interface, assigns IP addresses to all clients including WLAN clients and USB Terminal Equipment (TE). Therefore, all the clients get IP addresses allocated from the same subnet and address range. @datatypes qcmap_msgr_lan_config_v01\n qmi_error_type_v01 @param[in] lan_config LAN configuration parameters to set. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetLANConfig ( qcmap_msgr_lan_config_v01 lan_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetLANConfig() ===========================================================================*/ /** @ingroup qcmap_get_lan_config Gets the configured LAN configuration parameters. All LAN interfaces are bridged together using a bridge interface. A single instance of a DHCP server, running on the bridge interface, assigns IP addresses to all clients including WLAN clients and USB TE. Therefore, all the clients get IP addresses allocated from the same subnet and address range. @datatypes qcmap_msgr_lan_config_v01\n qmi_error_type_v01 @param[out] lan_config LAN configuration buffer to use. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetLANConfig ( qcmap_msgr_lan_config_v01 *lan_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION ActivateLAN() ===========================================================================*/ /** @ingroup qcmap_activate_lan Activates the LAN with the latest configuration. This activation might cause the WLAN to be disabled and re-enabled depending on the changes to the configuration. In either case, the backhaul is not affected. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean ActivateLAN ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetWLANStatus() ===========================================================================*/ /** @ingroup qcmap_get_wlan_status Gets the WLAN status. @datatypes qcmap_msgr_wlan_mode_enum_v01 - QCMAP_MSGR_WLAN_MODE_AP_V01\n WLAN is in AP mode. - QCMAP_MSGR_WLAN_MODE_AP_AP_V01\n WLAN is in AP/AP mode. - QCMAP_MSGR_WLAN_MODE_AP_STA_V01\n WLAN is in AP/STA mode. - QCMAP_MSGR_WLAN_MODE_AP_AP_AP_V01\n WLAN is in AP/AP/AP mode. - QCMAP_MSGR_WLAN_MODE_AP_AP_STA_V01\n WLAN is in AP/AP/STA mode. - QCMAP_MSGR_WLAN_MODE_STA_ONLY_V01 \n WLAN is in sta only mode. - QCMAP_MSGR_WLAN_MODE_AP_STA_BRIDGE_V01\n WLAN is in AP/STA Bridge mode; only used for GetWLANStatus. - QCMAP_MSGR_WLAN_MODE_AP_AP_STA_BRIDGE_V01\n WLAN is in AP/AP/STA Bridge mode; only used for GetWLANStatus. - QCMAP_MSGR_WLAN_MODE_STA_ONLY_BRIDGE_V01 \n WLAN is in sta only bridge mode. only used for GetWLANStatus. @par qmi_error_type_v01 @param[out] wlan_mode WLAN mode used. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetWLANStatus ( qcmap_msgr_wlan_mode_enum_v01 *wlan_mode, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION ActivateHostapdConfig() ===========================================================================*/ /** @ingroup qcmap_activate_hostapd_config Activates the hostapd configuration after the appropriate hostapd.conf is modified. @datatypes qcmap_msgr_activate_hostapd_ap_enum_v01 - QCMAP_MSGR_PRIMARY_AP_V01 - QCMAP_MSGR_GUEST_AP_V01 - QCMAP_MSGR_GUEST_AP_2_V01 - QCMAP_MSGR_ALL_AP_V01 @par qcmap_msgr_activate_hostapd_action_enum_v01 - QCMAP_MSGR_HOSTAPD_START_V01 - QCMAP_MSGR_HOSTAPD_STOP_V01 - QCMAP_MSGR_HOSTAPD_RESTART_V01 @par qmi_error_type_v01 @param[in] ap_type Indicates hostapd.conf associated with the ap_type to be activated. @param[in] action_type Indicates the action to be performed: start, stop, restart. @param[out] qmi_err_num Error code returned by the server. @param[in] privileged_client Sets the status of the privileged client. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean ActivateHostapdConfig ( qcmap_msgr_activate_hostapd_ap_enum_v01 ap_type, qcmap_msgr_activate_hostapd_action_enum_v01 action_type, qmi_error_type_v01 *qmi_err_num, boolean privileged_client = false ); /*=========================================================================== FUNCTION ActivateSupplicantConfig() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wlan @xreflabel{sec:activate_supplicant_config} Activates the WPA supplicant configuration after wpa_supplicant.conf is modified. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean ActivateSupplicantConfig ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION AddStaticNatEntry() ===========================================================================*/ /** @ingroup qcmap_add_static_nat_entry Adds a static entry in the Network Address Translation (NAT) table and updates the XML file with the new entry. @datatypes qcmap_msgr_snat_entry_config_v01\n qmi_error_type_v01 @param[in] snat_entry Static NAT configuration to add. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean AddStaticNatEntry ( qcmap_msgr_snat_entry_config_v01 *snat_entry, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteStaticNatEntry() ===========================================================================*/ /** @ingroup qcmap_delete_static_nat_entry Deletes the static entry from the NAT table. If the deletion is successful, this function also deletes the entry from the XML file. @datatypes qcmap_msgr_snat_entry_config_v01\n qmi_error_type_v01 @param[in] snat_entry Static NAT configuration to be deleted. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DeleteStaticNatEntry ( qcmap_msgr_snat_entry_config_v01 *snat_entry, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetStaticNatConfig() ===========================================================================*/ /** @ingroup qcmap_get_static_nat_config Gets the static entries in the NAT table. @datatypes qcmap_msgr_snat_entry_config_v01\n qmi_error_type_v01 @param[out] snat_config Static NAT entries configured. @param[out] num_entries Number of static NAT entries configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetStaticNatConfig ( qcmap_msgr_snat_entry_config_v01 *snat_config, int *num_entries, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION AddDMZ() ===========================================================================*/ /** @ingroup qcmap_add_dmz Adds the DMZ IP address and updates the XML file. This function gets the DMZ IP from the user and sends it to the QCMAP_MSGR server to be added as the DMZ server. It also updates the DMZ IP in the XML file. @datatypes qmi_error_type_v01 @param[in] dmz_ip DMZ IP to be added; address is in host byte order. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean AddDMZ ( uint32 dmz_ip, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteDMZ() ===========================================================================*/ /** @ingroup qcmap_delete_dmz Deletes the DMZ IP address and updates the DMZ IP address in the configuration XML file. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DeleteDMZ ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetDMZ() ===========================================================================*/ /** @ingroup qcmap_get_dmz Queries the DMZ entry that was previously set with the QMI_QCMAP_MSGR_SET_DMZ command. If no DMZ is set by the client, an IP address of 0.0.0.0 is returned. @datatypes qmi_error_type_v01 @param[out] dmz_ip DMZ IP configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetDMZ ( uint32_t *dmz_ip, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetWWANStatistics() ===========================================================================*/ /* TODO fix formatting/values on params!!*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_wwan_statistics} Gets the WWAN statistics. This function populates the QCMAP_Client::wwan_stats obtained from the QCMAP_MSGR server. @datatypes qcmap_msgr_ip_family_enum_v01\n qcmap_msgr_wwan_statistics_type_v01\n qmi_error_type_v01 @param[in] ip_family @values - 4 -- Gets the IPv4 WWAN statistics.\n - 6 -- Gets the IPv6 WWAN statistics. @tablebulletend @param[out] wwan_stats Statistics for the identified IP version. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetWWANStatistics ( qcmap_msgr_ip_family_enum_v01 ip_family, qcmap_msgr_wwan_statistics_type_v01 *wwan_stats, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION ResetWWANStatistics() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:reset_wwan_statistics} Resets the WWAN statistics for the specified IP version family. @datatypes qcmap_msgr_ip_family_enum_v01\n qmi_error_type_v01 @param[in] ip_family Values:\n - 4 -- Resets the IPv4 WWAN statistics. - 6 -- Resets the IPv6 WWAN statistics. @tablebulletend @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean ResetWWANStatistics ( qcmap_msgr_ip_family_enum_v01 ip_family, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetIPSECVpnPassthrough() ===========================================================================*/ /** @ingroup qcmap_set_ipsec_vpn_passthrough Sets the Internet Protocol Security (IPSec) Virtual Private Network (VPN) passthrough control flag. @datatypes qmi_error_type_v01 @param[in] enable Sets the IPSec VPN passthrough control flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetIPSECVpnPassthrough ( boolean enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetIPSECVpnPassthrough() ===========================================================================*/ /** @ingroup qcmap_get_ipsec_vpn_passthrough Gets the IPSec VPN passthrough control flag. @datatypes qmi_error_type_v01 @param[out] enable Gets the IPSec VPN passthrough control flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPSECVpnPassthrough ( boolean *enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetPPTPVpnPassthrough() ===========================================================================*/ /** @ingroup qcmap_set_pptp_vpn_passthrough Sets the Point-to-Point Tunneling Protocol (PPTP) VPN passthrough control flag. @datatypes qmi_error_type_v01 @param[in] enable Sets the PPTP VPN passthrough control flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetPPTPVpnPassthrough ( boolean enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetPPTPVpnPassthrough() ===========================================================================*/ /** @ingroup qcmap_get_pptp_vpn_passthrough Gets the PPTP VPN passthrough control flag. @datatypes qmi_error_type_v01 @param[out] enable Gets the PPTP VPN passthrough control flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetPPTPVpnPassthrough ( boolean *enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetL2TPVpnPassthrough() ===========================================================================*/ /** @ingroup qcmap_set_l2tp_vpn_passthrough Sets the Layer 2 Tunneling Protocol (L2TP) VPN passthrough control flag. @datatypes qmi_error_type_v01 @param[in] enable Sets the L2TP VPN passthrough control flag @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetL2TPVpnPassthrough ( boolean enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetL2TPVpnPassthrough() ===========================================================================*/ /** @ingroup qcmap_get_l2tp_vpn_passthrough Gets the L2TP VPN passthrough control flag. @datatypes qmi_error_type_v01 @param[out] enable Gets the L2TP VPN passthrough control flag @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetL2TPVpnPassthrough ( boolean *enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetWebserverWWANAccess() ===========================================================================*/ /** @ingroup qcmap_set_webserver_wwan_access Sets whether or not the webserver can be accessed from the WWAN interface. The command handler overwrites any previously configured value with the current value. @datatypes qmi_error_type_v01 @param[in] enable Sets the web server WWAN access flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetWebserverWWANAccess ( boolean enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetWebserverWWANAccess() ===========================================================================*/ /** @ingroup qcmap_get_webserver_wwan_access Queries the webserver WWAN access status on the device. @datatypes qmi_error_type_v01 @param[out] enable Gets the web server's WWAN access status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetWebserverWWANAccess ( boolean *enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetNatType() ===========================================================================*/ /** @ingroup qcmap_set_nat_type Sets the NAT type on the device. The command handler overwrites any previously configured value with the current value. @datatypes qcmap_msgr_nat_enum_v01\n qmi_error_type_v01 @param[in] nat_type NAT type to be configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetNatType ( qcmap_msgr_nat_enum_v01 nat_type, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetNatType() ===========================================================================*/ /** @ingroup qcmap_get_nat_type Gets the configured NAT type. @datatypes qcmap_msgr_nat_enum_v01\n qmi_error_type_v01 @param[out] nat_type NAT type which is configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetNatType ( qcmap_msgr_nat_enum_v01 *nat_type, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetAutoconnect() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:set_autoconnect} Sets the Auto Connect flag, which is then updated in the configuration file by the Connection Manager. This enables the QCMobileAP to connect to the backhaul after the QCMobileAP is enabled and to retry to connect to the backhaul on failure. @datatypes qmi_error_type_v01 @param[in] enable Sets the auto connect flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetAutoconnect ( boolean enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetAutoconnect() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_autoconnect} Gets the status of the auto connect flag. @datatypes qmi_error_type_v01 @param[out] enable Gets the auto connect control flag status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetAutoconnect ( boolean *enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetRoaming() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:set_roaming} Sets the roaming flag. The roaming flag is then updated in the configuration file by the Connection Manager. This enables the QCMobileAP to connect to the network in roaming mode. @datatypes qmi_error_type_v01 @param[in] enable Sets the roaming flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetRoaming ( boolean enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetRoaming() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_roaming} Gets the status of the roaming flag. @datatypes qmi_error_type_v01 @param[out] enable Gets the status of the roaming flag. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetRoaming ( boolean *enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetNetworkConfiguration() ===========================================================================*/ /** @ingroup qcmap_get_network_configuration Gets the IPv4 network configuration. @datatypes qcmap_msgr_ip_family_enum_v01\n qcmap_nw_params_t\n qmi_error_type_v01 @param[in] ip_family IP family for which to get the configuration. @param[out] qcmap_nw_params Network configuration, such as public IP, and primary and secondary DNS IP addresses. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetNetworkConfiguration ( qcmap_msgr_ip_family_enum_v01 ip_family, qcmap_nw_params_t *qcmap_nw_params, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetIPv4NetworkConfiguration() ===========================================================================*/ /** @ingroup qcmap_get_ipv4_network_configuration Gets the IPv4 network configuration. @datatypes qmi_error_type_v01 @param[out] public_ip Public IP address. @param[out] primary_dns Primary DNS IP address. @param[out] secondary_dns Secondary DNS IP address. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPv4NetworkConfiguration ( in_addr_t *public_ip, uint32 *primary_dns, in_addr_t *secondary_dns, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetIPv6NetworkConfiguration() ===========================================================================*/ /** @ingroup qcmap_get_ipv6_network_configuration Gets the IPV6 configuration. @datatypes struct in6_addr\n qmi_error_type_v01 @param[out] public_ip Public IP address. @param[out] primary_dns Primary DNS IP address. @param[out] secondary_dns Secondary DNS IP address. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPv6NetworkConfiguration ( struct in6_addr *public_ip, struct in6_addr *primary_dns, struct in6_addr *secondary_dns, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetNatTimeout() ===========================================================================*/ /** @ingroup qcmap_set_nat_timeout Sets different NAT timeouts on the device. The command handler overwrites any previously configured value with the current value. @datatypes qcmap_msgr_nat_timeout_enum_v01\n qmi_error_type_v01 @param[in] timeout_type NAT timeout type for which the timeout is to be set. @param[in] timeout_value Timeout value. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetNatTimeout ( qcmap_msgr_nat_timeout_enum_v01 timeout_type, uint32 timeout_value, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetNatTimeout() ===========================================================================*/ /** @ingroup qcmap_get_nat_timeout Gets the NAT timeout value configured for the NAT type. @datatypes qcmap_msgr_nat_timeout_enum_v01\n qmi_error_type_v01 @param[in] timeout_type NAT timeout type for which the timeout is to be fetched. @param[out] timeout_value Timeout value. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetNatTimeout ( qcmap_msgr_nat_timeout_enum_v01 timeout_type, uint32 *timeout_value, qmi_error_type_v01 *qmi_err_num ); /* @addtogroup qcmap_fields @{ */ /* QMI QCMAP_CM service information. */ qmi_client_type qmi_qcmap_msgr_handle; /*< Connection manager messenger handle. */ qmi_client_type qmi_qcmap_msgr_notifier; /*< Connection manager messenger notifier. */ qmi_cci_os_signal_type qmi_qcmap_msgr_os_params; /*< Connection manager messenger OS parameters. */ /* @} */ /* endaddtogroup qcmap_fields */ /*=========================================================================== FUNCTION GetFireWallHandlesList() ===========================================================================*/ /** @ingroup qcmap_get_fire_wall_handles_list Gets all the firewall handles associated with a single MobileAP instance. @datatypes qcmap_msgr_get_firewall_handle_list_conf_t\n qmi_error_type_v01 @param[out] handlelist List of firewall handles. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetFireWallHandlesList ( qcmap_msgr_get_firewall_handle_list_conf_t *handlelist, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION AddFireWallEntry() ===========================================================================*/ /** @ingroup qcmap_add_fire_wall_entry Adds the firewall rule, which is then updated in the configuration file by the Connection Manager @datatypes qcmap_msgr_firewall_conf_t\n qmi_error_type_v01 @param[in] extd_firewall_entry Firewall rule to be set. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean AddFireWallEntry ( qcmap_msgr_firewall_conf_t *extd_firewall_entry, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION AddUPNPPinholeEntry() ===========================================================================*/ /** @ingroup qcmap_add_upnp_pinhole_entry Adds a UPNP pinhole entry. @datatypes qcmap_msgr_firewall_conf_t\n qmi_error_type_v01 @param[in] extd_firewall_entry UPNP pinhole entry to be set. @param[out] qmi_err_num Error code returned by the server. @param[in] upnp_pinhole Indicates whether to add the pinhole entry. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean AddUPNPPinholeEntry ( qcmap_msgr_firewall_conf_t *extd_firewall_entry, qmi_error_type_v01 *qmi_err_num, boolean upnp_pinhole = false ); /*=========================================================================== FUNCTION GetFireWallEntry() ===========================================================================*/ /** @ingroup qcmap_get_fire_wall_entry Gets a firewall rule associated with a single firewall handle. @datatypes qcmap_msgr_firewall_entry_conf_t\n qmi_error_type_v01 @param[in,out] firewall_entry Firewall entry pointed to by the handle requested. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetFireWallEntry ( qcmap_msgr_firewall_entry_conf_t *firewall_entry, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteFireWallEntry() ===========================================================================*/ /** @ingroup qcmap_delete_fire_wall_entry Deletes the firewall rule pointed by the handle, which is then updated by the Connection Manager in the configuration file. @datatypes qmi_error_type_v01 @param[in] handle Handle that points to the firewall to be deleted. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ int DeleteFireWallEntry ( int handle, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetMobileAPStatus() ===========================================================================*/ /** @ingroup qcmap_get_mobile_ap_status Gets the QCMobileAP status. @datatypes qcmap_msgr_mobile_ap_status_enum_v01\n qmi_error_type_v01 @param[out] status QCMobileAP status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetMobileAPStatus ( qcmap_msgr_mobile_ap_status_enum_v01 *status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetWWANStatus() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_wwan_status} Gets the status of the WWAN connection. @datatypes qcmap_msgr_wwan_status_enum_v01\n qcmap_msgr_wwan_status_enum_v01\n qmi_error_type_v01 @param[out] v4_status WWAN connection status for the IPv4 call type. @param[out] v6_status WWAN connection status for the IPv6 call type. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetWWANStatus ( qcmap_msgr_wwan_status_enum_v01 *v4_status, qcmap_msgr_wwan_status_enum_v01 *v6_status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetStationModeStatus() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wlan @xreflabel{sec:get_station_mode_status} Gets the status of the WLAN station mode connection. @datatypes qcmap_msgr_station_mode_status_enum_v01\n qmi_error_type_v01 @param[out] status WLAN station mode connection status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetStationModeStatus ( qcmap_msgr_station_mode_status_enum_v01 *status, qmi_error_type_v01 *qmi_err_num ); /*=====================================sec====================================== FUNCTION SetFirewall() ===========================================================================*/ /** @ingroup qcmap_set_firewall Enables or disables the firewall and sets the configuration to drop or accept the packets matching the rules. @datatypes qmi_error_type_v01 @param[in] enable_firewall Indicates whether the firewall is enabled. @param[in] pkts_allowed Indicates whether to accept or drop packets matching the rules. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetFirewall ( boolean enable_firewall, boolean pkts_allowed, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetFirewall() ===========================================================================*/ /** @ingroup qcmap_get_firewall Gets the firewall configuration. This function indicates whether the firewall is enabled or disabled and whether the firewall is configured to drop or accept the packets matching the rules. @datatypes qmi_error_type_v01 @param[out] enable_firewall Indicates whether the firewall is enabled. @param[out] pkts_allowed Indicates whether to accept or drop packets matching the rules. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetFirewall ( boolean *enable_firewall, boolean *pkts_allowed, qmi_error_type_v01 *qmi_err_num ); /*=====================================sec====================================== FUNCTION SetUPNPState() ===========================================================================*/ /** @ingroup qcmap_set_upnp_state Enables or disables the UPNP pinhole. @datatypes qmi_error_type_v01 @param[in] firewall_state Indicates whether the firewall is enabled. @param[in] upnp_pinhole_flag Indicates whether to enable or disable the UPNP pinhole. \n @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetUPNPState ( boolean firewall_state, boolean upnp_pinhole_flag, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetUPNPState() ===========================================================================*/ /** @ingroup qcmap_get_upnp_state Gets the pinhole state. @datatypes qmi_error_type_v01 @param[out] upnp_pinhole_flag Indicates whether the pinhole is enabled. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetUPNPState ( boolean *upnp_pinhole_flag, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetIPv4State() ===========================================================================*/ /** @ingroup qcmap_get_ipv4_state Gets the current IPv4 state. @datatypes qmi_error_type_v01 @param[out] ipv4_state Indicates whether IPv4 is enabled. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPv4State ( boolean *ipv4_state, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetIPv6State() ===========================================================================*/ /** @ingroup qcmap_get_ipv6_state Gets the current IPv6 state. @datatypes qmi_error_type_v01 @param[out] ipv6_state Indicates whether IPv6 is enabled. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPv6State ( boolean *ipv6_state, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetWWANPolicy() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_wwan_policy} Gets the current configured WWAN policy. @datatypes qcmap_msgr_net_policy_info_v01\n qmi_error_type_v01 @param[out] WWAN_config WWAN policy configured in the XML file. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetWWANPolicy ( qcmap_msgr_net_policy_info_v01 *WWAN_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetWWANPolicyList() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_allwwan_policy} Gets all configured WWAN policy. @datatypes qcmap_msgr_wwan_policy_list_resp_msg_v01\n qmi_error_type_v01 @param[out] WWAN_config WWAN policy configured in the XML file. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetWWANPolicyList ( qcmap_msgr_wwan_policy_list_resp_msg_v01 *WWAN_policy, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetWWANPolicy() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:set_wwan_policy} Configures the WWAN policy. @datatypes qcmap_msgr_net_policy_info_v01\n qmi_error_type_v01 @param[in] WWAN_config WWAN policy information to be configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies 1. QCMobileAP must be enabled. 2. It is recommended to use same WWAN profile index for both IPv4 and IPv6 data calls, intended for Internet or Default PDN. */ boolean SetWWANPolicy ( qcmap_msgr_net_policy_info_v01 WWAN_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION CreateWWANPolicy() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:create_wwan_policy} Create's WWAN policy. @datatypes qcmap_msgr_net_policy_info_v01\n qmi_error_type_v01 @param[in] WWAN_config WWAN policy information to be configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean CreateWWANPolicy ( qcmap_msgr_net_policy_info_v01 WWAN_policy, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION UpdateWWANPolicy() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:update_wwan_policy} Update WWAN policy. @datatypes qcmap_msgr_update_profile_enum_v01\n qcmap_msgr_net_policy_info_v01\n qmi_error_type_v01 @param[in] update_req Policy field to be modified. @param[in] WWAN_config WWAN policy information to be configured. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean UpdateWWANPolicy ( qcmap_msgr_update_profile_enum_v01 update_req, qcmap_msgr_net_policy_info_v01 WWAN_policy, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteWWANPolicy() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:delete_wwan_policy} Delete's WWAN policy. @datatypes profile_handle\n qmi_error_type_v01 @param[in] profile_handle Identifies profile_handle @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DeleteWWANPolicy ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EnableUPNP() ===========================================================================*/ /** @ingroup qcmap_enable_upnp Enables the Universal Plug and Play (UPnP) daemon, unless it is already running. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean EnableUPNP ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableUPNP() ===========================================================================*/ /** @ingroup qcmap_disable_upnp Disables the UPnP daemon, if it is running. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean DisableUPNP ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetUPNPStatus() ===========================================================================*/ /** @ingroup qcmap_get_upnp_status Returns the status of the UPnP daemon. @datatypes qcmap_msgr_upnp_mode_enum_v01\n qmi_error_type_v01 @param[out] upnp_status UPnP status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetUPNPStatus ( qcmap_msgr_upnp_mode_enum_v01 *upnp_status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EnableDLNA() ===========================================================================*/ /** @ingroup qcmap_enable_dlna Enables the Digital Living Network Alliance (DLNA) daemon, unless it is already running @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean EnableDLNA ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableDLNA() ===========================================================================*/ /** @ingroup qcmap_disable_dlna Disables the DLNA daemon, if it is running. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean DisableDLNA ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetDLNAStatus() ===========================================================================*/ /** @ingroup qcmap_get_dlna_status Returns the status of the DLNA daemon. @datatypes qcmap_msgr_dlna_mode_enum_v01\n qmi_error_type_v01 @param[out] dlna_status DLNA status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetDLNAStatus ( qcmap_msgr_dlna_mode_enum_v01 *dlna_status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetDLNAMediaDir() ===========================================================================*/ /** @ingroup qcmap_get_dlna_media_dir Returns the DLNA media directory. @datatypes qmi_error_type_v01 @param[out] media_dir DLNA media directory path. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetDLNAMediaDir ( char media_dir[], qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetDLNAMediaDir() ===========================================================================*/ /** @ingroup qcmap_set_dlna_media_dir Sets the DLNA media directory. @datatypes qmi_error_type_v01 @param[in] media_dir DLNA media directory. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetDLNAMediaDir ( char media_dir[], qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EnableMDNS() ===========================================================================*/ /** @ingroup qcmap_enable_mdns Enables the Multicast DNS (MDNS) responder for QCMAP. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean EnableMDNS ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableMDNS() ===========================================================================*/ /** @ingroup qcmap_disable_mdns Disables the MDNS responder for QCMAP. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean DisableMDNS ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetMDNSStatus() ===========================================================================*/ /** @ingroup qcmap_get_mdns_status Returns the status of the Multicast DNS mode. @datatypes qcmap_msgr_mdns_mode_enum_v01\n qmi_error_type_v01 @param[out] mdns_status MDNS status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetMDNSStatus ( qcmap_msgr_mdns_mode_enum_v01 *mdns_status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetQCMAPBootupCfg() ===========================================================================*/ /** @ingroup qcmap_set_qcmap_bootup_cfg Sets the MobileAP boot-up configuration. @datatypes qcmap_msgr_bootup_flag_v01\n qcmap_msgr_bootup_flag_v01\n qmi_error_type_v01 @param[in] mobileap_enable Flag to indicate MobileAP bring-up at boot-up. @param[in] wlan_enable Flag to indicate WLAN bring-up at boot-up. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetQCMAPBootupCfg ( qcmap_msgr_bootup_flag_v01 mobileap_enable, qcmap_msgr_bootup_flag_v01 wlan_enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetQCMAPBootupCfg() ===========================================================================*/ /** @ingroup qcmap_get_qcmap_bootup_cfg Gets the MobileAP boot-up configuration. @datatypes qcmap_msgr_bootup_flag_v01\n qcmap_msgr_bootup_flag_v01\n qmi_error_type_v01 @param[out] mobileap_enable Flag to indicate MobileAP bring-up at boot-up. @param[out] wlan_enable Flag to indicate WLAN bring-up at boot-up. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetQCMAPBootupCfg ( qcmap_msgr_bootup_flag_v01 *mobileap_enable, qcmap_msgr_bootup_flag_v01 *wlan_enable, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetDataRate() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_data_rate} Gets the current and maximum transmit and receive data rates. @datatypes qcmap_msgr_data_bitrate_v01\n qmi_error_type_v01 @param[out] data_rate Tx and Rx current and maximum data rates, in bps. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetDataRate ( qcmap_msgr_data_bitrate_v01 *data_rate, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetUPNPNotifyInterval() ===========================================================================*/ /** @ingroup qcmap_set_upnp_notify_interval Sets the UPnP notify interval. @datatypes qmi_error_type_v01 @param[in] notify_int Notify interval, in seconds. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetUPNPNotifyInterval ( int notify_int, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetUPNPNotifyInterval() ===========================================================================*/ /** @ingroup qcmap_get_upnp_notify_interval Gets the UPnP notify interval. @datatypes qmi_error_type_v01 @param[out] notify_int Notify interval, in seconds. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetUPNPNotifyInterval ( int *notify_int, qmi_error_type_v01 *qmi_err_num ); /* Set/Get the DLNA SSDP notify interval rate */ /*=========================================================================== FUNCTION SetDLNANotifyInterval() ===========================================================================*/ /** @ingroup qcmap_set_dlna_notify_interval Sets the DLNA notify interval. @datatypes qmi_error_type_v01 @param[in] notify_int Notify interval, in seconds. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetDLNANotifyInterval ( int notify_int, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetDLNANotifyInterval() ===========================================================================*/ /** @ingroup qcmap_get_dlna_notify_interval Gets the DLNA notify interval. @datatypes qmi_error_type_v01 @param[out] notify_int Notify interval, in seconds. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetDLNANotifyInterval ( int *notify_int, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION AddDHCPReservRecord() ===========================================================================*/ /** @ingroup qcmap_add_dhcp_reserv_record Adds a DHCP reservation record. @datatypes qcmap_msgr_dhcp_reservation_v01\n qmi_error_type_v01 @param[in] dhcp_reserv_record DHCP reservation record. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean AddDHCPReservRecord ( qcmap_msgr_dhcp_reservation_v01 *dhcp_reserv_record, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetDHCPReservRecords() ===========================================================================*/ /** @ingroup qcmap_get_dhcp_reserv_records Gets all the configured DHCP reservation records. @datatypes qcmap_msgr_dhcp_reservation_v01\n qmi_error_type_v01 @param[out] dhcp_reserv_record DHCP reservation record. @param[out] num_entries Number of DHCP reservation records. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetDHCPReservRecords ( qcmap_msgr_dhcp_reservation_v01 *dhcp_reserv_record, uint32_t *num_entries, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EditDHCPReservRecord() ===========================================================================*/ /** @ingroup qcmap_edit_dhcp_reserv_record Edits an already configured DHCP reservation record. @datatypes qcmap_msgr_dhcp_reservation_v01\n qmi_error_type_v01 @param[in] addr IP address used as an index in the DHCP reservation record list. @param[in] dhcp_reserv_record Modified DHCP reservation record. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EditDHCPReservRecord ( uint32_t *addr, qcmap_msgr_dhcp_reservation_v01 *dhcp_reserv_record, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteDHCPReservRecord() ===========================================================================*/ /** @ingroup qcmap_delete_dhcp_reserv_record Deletes a DHCP reservation record. @datatypes qmi_error_type_v01 @param[in] addr IP address used to index into the DHCP reservation record list. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DeleteDHCPReservRecord ( uint32_t *addr, qmi_error_type_v01 *qmi_err_num ); uint32_t mobile_ap_handle; /*< Handle for the mobile ap*/ /*=========================================================================== FUNCTION EnableAlg() ===========================================================================*/ /** @ingroup qcmap_enable_alg Enables Application Level Gateways (ALGs) specified in the bitmask at runtime. @datatypes qcmap_msgr_alg_type_mask_v01\n qmi_error_type_v01 @param[in] alg_types Bitmask indicating the ALGs to be loaded. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EnableAlg ( qcmap_msgr_alg_type_mask_v01 alg_types, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableAlg() ===========================================================================*/ /** @ingroup qcmap_disable_alg Disables the ALGs specified in the bitmask at runtime. @datatypes qcmap_msgr_alg_type_mask_v01\n qmi_error_type_v01 @param[in] alg_types Bitmask indicating the algorithms to be loaded. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DisableAlg ( qcmap_msgr_alg_type_mask_v01 alg_types, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetSIPServerInfo() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:set_sip_server_info} Sets the default SIP server information in the QCMAP server, which is propagated to the LAN clients through DHCP. @datatypes qcmap_msgr_sip_server_info_v01\n qmi_error_type_v01 @param[in] sip_server_info Default SIP server information. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetSIPServerInfo ( qcmap_msgr_sip_server_info_v01 *sip_server_info, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetSIPServerInfo() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_sip_server_info} Obtains the default SIP server information and the network assigned SIP server information from the QCMAP server. @datatypes qcmap_msgr_sip_server_info_v01\n qmi_error_type_v01 @param[out] default_sip_info Default SIP server information. @param[out] network_sip_info Network assigned SIP server information. @param[out] count_network_sip_info Number of network assigned SIP servers returned. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetSIPServerInfo ( qcmap_msgr_sip_server_info_v01 *default_sip_info, qcmap_msgr_sip_server_info_v01 *network_sip_info, int *count_network_sip_info, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetV6SIPServerInfo() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_v6sip_server_info} Sends a QMI message to the QCMAP server to get the V6SIP server information. This function populates the necessary fields for the QMI_QCMAP_MSGR_GET_IPV6_SIP_SERVER_INFO_REQ request. @datatypes qcmap_msgr_ipv6_sip_server_info_v01\n qmi_error_type_v01 @param[out] network_v6_sip_info Network V6 assigned SIP server information. @param[out] count_network_sip_info Number of network V6 assigned SIP servers returned. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetV6SIPServerInfo ( qcmap_msgr_ipv6_sip_server_info_v01 *network_v6_sip_info, int *count_network_sip_info, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION RestoreFactoryConfig() ===========================================================================*/ /** @ingroup qcmap_restore_factory_config Restores the QCMAP configuration to a factory default state and reboots the device. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean RestoreFactoryConfig ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetConnectedDevicesInfo() ===========================================================================*/ /** @ingroup qcmap_get_connected_devices_info Gets information about the connected LAN hosts. LAN hosts include both USB and WLAN clients. The information includes the MAC address, IP address, host name, and lease expiry time. @datatypes qcmap_msgr_connected_device_info_v01\n qmi_error_type_v01 @param[out] conn_dev_info Connected device information retrieved from the server. @param[out] num_entries Number of entries. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetConnectedDevicesInfo ( qcmap_msgr_connected_device_info_v01 *conn_dev_info, int *num_entries, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetSupplicantConfig() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wlan @xreflabel{sec:set_supplicant_config} Activates and deactivates the WPA supplicant and WPA CLI based on the supplicant configuration status flag. @datatypes qmi_error_type_v01 @param[out] status Flag indicating whether to activate or deactivate the WPA supplicant. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetSupplicantConfig ( boolean status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetCradleMode() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_cradle @xreflabel{sec:get_cradle_mode} Gets the current cradle mode configured on the device. @datatypes qcmap_msgr_cradle_mode_v01\n qmi_error_type_v01 @param[out] mode Gets the cradle mode. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetCradleMode ( qcmap_msgr_cradle_mode_v01 *mode, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetCradleMode() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_cradle @xreflabel{sec:set_cradle_mode} Configures a new cradle mode unless the mode is already set. @datatypes qcmap_msgr_cradle_mode_v01\n qmi_error_type_v01 @param[in] mode Sets the cradle mode. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetCradleMode ( qcmap_msgr_cradle_mode_v01 mode, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetPrefixDelegationConfig() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_prefix_delegation_config} Gets whether the prefix delegation configuration is enabled or disabled. @datatypes qmi_error_type_v01 @param[out] pd_mode Prefix delegation configuration. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetPrefixDelegationConfig ( boolean *pd_mode, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetPrefixDelegationConfig() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:set_prefix_delegation_config} Sets the prefix delegation configuration. @datatypes qmi_error_type_v01 @param[in] pd_mode Prefix delegation configuration. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetPrefixDelegationConfig ( boolean pd_mode, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION GetPrefixDelegationStatus() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_prefix_delegation_status} Gets the current prefix delegation mode. @datatypes qmi_error_type_v01 @param[out] pd_mode Prefix delegation mode. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetPrefixDelegationStatus ( boolean *pd_mode, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION SetGatewayUrl() =====================================================================*/ /** @ingroup qcmap_set_gateway_url Sets the default gateway URL for the access point. @datatypes qmi_error_type_v01 @param[in] url URL to set. @param[in] url_len URL length. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetGatewayUrl ( uint8_t *url, uint32_t url_len, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION GetGatewayUrl() =====================================================================*/ /** @ingroup qcmap_get_gateway_url Gets the default gateway URL for the access point. @datatypes qmi_error_type_v01 @param[out] url URL to get. @param[out] url_len URL length. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetGatewayUrl ( uint8_t *url, uint32_t *url_len, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION EnableDDNS() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:enable_ddns} Enables dynamic DNS, which updates the IP address of the name server in the Domain Name System. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean EnableDDNS ( qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION DisableDDNS() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:disable_ddns} Disables the dynamic DNS service. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean DisableDDNS ( qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION SetDDNSConfig() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:set_ddns_config} Sets the dynamic DNS configuration. @datatypes qcmap_msgr_set_dynamic_dns_config_req_msg_v01\n qmi_error_type_v01 @param[in] setddns_cfg_req Required dynamic DNS configuration to set. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetDDNSConfig ( qcmap_msgr_set_dynamic_dns_config_req_msg_v01 *setddns_cfg_req, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION GetDDNSConfig() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_ddns_config} Gets the current dynamic DNS configuration. @datatypes qcmap_msgr_get_dynamic_dns_config_resp_msg_v01\n qmi_error_type_v01 @param[in] ddns_server Dynamic DNS configuration. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetDDNSConfig ( qcmap_msgr_get_dynamic_dns_config_resp_msg_v01 *ddns_server, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetTinyProxyStatus() ===========================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:get_tiny_proxy_status} Returns the status of the Tiny Proxy. @datatypes qcmap_msgr_tiny_proxy_mode_enum_v01\n qmi_error_type_v01 @param[out] tiny_proxy_status Tiny Proxy status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetTinyProxyStatus(qcmap_msgr_tiny_proxy_mode_enum_v01 *tiny_proxy_status, qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION EnableTinyProxy() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:enable_tiny_proxy} Enables Tiny Proxy. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean EnableTinyProxy(qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION DisableTinyProxy() =====================================================================*/ /** @ingroup section_qcmap_backhaul_wwan @xreflabel{sec:disable_tiny_proxy} Disables the Tiny Proxy. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean DisableTinyProxy(qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION SetDLNAWhitelisting() =====================================================================*/ /** @ingroup qcmap_set_dlna_whitelisting Sets the DLNA whitelisting state. @datatypes qmi_error_type_v01 @param[in] dlna_whitelisting_allow Indicates whether to set the whitelisting IP state. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean SetDLNAWhitelisting(boolean dlna_whitelisting_allow, qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION GetDLNAWhitelisting() =====================================================================*/ /** @ingroup qcmap_get_dlna_whitelisting Gets the DLNA whitelisting state. @datatypes qmi_error_type_v01 @param[out] dlna_whitelisting_allow Indicates whether to get the whitelisting IP state. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean GetDLNAWhitelisting(boolean *dlna_whitelisting_allow, qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION AddDLNAWhitelistIP() =====================================================================*/ /** @ingroup qcmap_add_dlna_whitelist_ip Adds the DLNA whitelisting IP. @datatypes qmi_error_type_v01 @param[in] dlna_whitelisting_ip DLNA whitelisting IP to add. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean AddDLNAWhitelistIP(uint32 dlna_whitelisting_ip , qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION DeleteDLNAWhitelistIP() =====================================================================*/ /** @ingroup qcmap_delete_dlna_whitelist_ip Deletes the DLNA whitelisting IP. @datatypes qmi_error_type_v01 @param[in] dlna_whitelisting_ip DLNA whitelisting IP to delete. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies None. */ boolean DeleteDLNAWhitelistIP(uint32 dlna_whitelisting_ip, qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION SetActiveBackhaulPref() =====================================================================*/ /** @ingroup section_qcmap_backhaul_pref @xreflabel{sec:set_active_backhaul_pref} Sets the backhaul preference. @datatypes qcmap_msgr_set_backhaul_pref_req_msg_v01 \n qmi_error_type_v01 @param[in] backhaul_pref_req Backhaul preference. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean SetActiveBackhaulPref ( backhaul_pref_t *backhaul_pref_req, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION GetBackhaulPref() =====================================================================*/ /** @ingroup section_qcmap_backhaul_pref @xreflabel{sec:get_backhaul_pref} Gets the backhaul preference. @datatypes qcmap_msgr_backhaul_type_enum_v01 qmi_error_type_v01 @param[in] resp Backhaul preference. @param[out] qmi_err_num Error code returned by the server. @newpage @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean GetBackhaulPref ( backhaul_pref_t *resp, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetEthernetMode() ===========================================================================*/ /** @ingroup section_backhaul_ethernet_mode @xreflabel{sec:get_ethernet_mode} Gets the current Ethernet mode configured on the device. @datatypes qcmap_msgr_eth_mode_v01 \n - QCMAP_MSGR_ETH_BACKHAUL_LAN_ROUTER = 0x00 \n ETH tethering in LAN mode. - QCMAP_MSGR_ETH_BACKHAUL_WAN_BRIDGE\n ETH Tethering in WAN Bridge Mode - Currently not supported - QCMAP_MSGR_ETH_BACKHAUL_WAN_ROUTER \n ETH tethering in WAN Router mode. @par qmi_error_type_v01 @param[out] mode Gets the Ethernet backhaul mode. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. @newpage */ boolean GetEthernetMode ( qcmap_msgr_ethernet_mode_v01 *mode, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetEthernetMode() ===========================================================================*/ /** @ingroup section_backhaul_ethernet_mode @xreflabel{sec:set_ethernet_mode} Configures a new Ethernet mode unless the mode is already set. @datatypes qcmap_msgr_ethernet_mode_v01 \n - QCMAP_MSGR_ETHERNET_LAN_ROUTER = 0x00 \n ETH tethering in LAN mode. - QCMAP_MSGR_ETHERNET_WAN_ROUTER \n ETH tethering in WAN Router mode. @par qmi_error_type_v01 @param[in] mode Sets the Ethernet backhaul mode. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean SetEthernetMode ( qcmap_msgr_ethernet_mode_v01 mode, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetIPPassthroughConfig() ===========================================================================*/ /** @ingroup qcmap_set_ip_passthrough_config IP passthrough functionality enables the tethered client to get the WWAN interface IP. As part of this functionality, the existing private IP is not deleted from the bridge interface. Instead, another public IP, which is the WWAN interface gateway IP is added to the bridge interface. This allows support for embedded application concurrency with the passthrough client. The WWAN interface is assigned a private IP. This API sets the IP passthrough flag and configuration for a tethered client (USB or Ethernet). When the flag is set to FALSE, IP passthrough is deactivated. When the flag is set to TRUE, there is a provision for reusing or overwriting the previously used configuration of the tethered client. The XML is updated with the information provided via this API. Even if the flag is set to TRUE in XML, IP passthrough is activated only when all required conditions are met. @datatypes qcmap_msgr_ip_passthrough_mode_enum_v01 - QCMAP_MSGR_IP_PASSTHROUGH_MODE_DOWN_V01 \n IP Passthrough mode is down. - QCMAP_MSGR_IP_PASSTHROUGH_MODE_UP_V01 \n IP Passthrough mode is up. @par qcmap_msgr_ip_passthrough_config_v01 qmi_error_type_v01 @param[in] enable_state IP passthrough enable state. @param[in] new_config Use new or existing configuration. @param[in] ip_passthrough_config IP passthrough configuration. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies QCMobileAP must be enabled. */ boolean SetIPPassthroughConfig ( qcmap_msgr_ip_passthrough_mode_enum_v01 enable_state, bool new_config, qcmap_msgr_ip_passthrough_config_v01 *ip_passthrough_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetIPPassthroughConfig() ===========================================================================*/ /** @ingroup qcmap_get_ip_passthrough_config Gets the current IP passthrough flag and configuration from XML. @datatypes qcmap_msgr_ip_passthrough_mode_enum_v01 - QCMAP_MSGR_IP_PASSTHROUGH_MODE_DOWN_V01 \n IP passthrough mode is down. - QCMAP_MSGR_IP_PASSTHROUGH_MODE_UP_V01 \n IP passthrough mode is up. @par qcmap_msgr_ip_passthrough_config_v01 qmi_error_type_v01 @param[out] enable_state Current state of IP passthrough. @param[out] ip_passthrough_config IP passthrough configuration. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPPassthroughConfig ( qcmap_msgr_ip_passthrough_mode_enum_v01 *enable_state, qcmap_msgr_ip_passthrough_config_v01 *ip_passthrough_config, qmi_error_type_v01 * qmi_err_num ); /*=========================================================================== FUNCTION GetIPPassthroughState() ===========================================================================*/ /** @ingroup qcmap_get_ip_passthrough_state Gets the IP passthrough current active state. Even if the flag is set to TRUE in XML, IP passthrough may not be in the Active state if the required conditions are not met. @datatypes qmi_error_type_v01 @param[out] state Current active state of IP passthrough. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies QCMobileAP must be enabled. */ boolean GetIPPassthroughState ( boolean *state, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION BringupBTTethering() =====================================================================*/ /* @ingroup qcmap_msgr_bring_up_bt_tethering Brings up Bluetooth tethering. This API can be used to bring up Bluetooth tethering from the QCMAP side. This API is called by the QCMAP client BT PAN module. The BT PAN module calls this API when the first Bluetooth client is connected. A call to this API brings up the Bluetooth interface, adds to the bridge interface, and assigns a private IP to the Bluetooth interface. @datatypes qcmap_bt_tethering_mode_enum_v01 -# QCMAP_MSGR_BT_MODE_LAN_V01 BT Tethering LAN Mode -# QCMAP_MSGR_BT_MODE_WAN_V01 BT Tethering WAN Mode qmi_error_type_v01 @param[out] bt_tethering_mode bt_tethering_mode @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean BringupBTTethering ( qmi_error_type_v01 *qmi_err_num, qcmap_bt_tethering_mode_enum_v01 bt_tethering_mode = QCMAP_MSGR_BT_MODE_LAN_V01 ); /*==================================================================== FUNCTION BringdownBTTethering() =====================================================================*/ /* @ingroup qcmap_msgr_bring_down_bt_tethering Brings down Bluetooth tethering from the QCMAP side. The QCMAP client BT PAN module calls this API when no Bluetooth client is connected. A call to this API brings the Bluetooth interface down and removes the changes from the bring-up Bluetooth tethering. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean BringdownBTTethering(qmi_error_type_v01 *qmi_err_num); /*=========================================================================== FUNCTION GetBTTetheringStatus() ===========================================================================*/ /* @ingroup qcmap_msgr_get_bt_tethering_status Gets the Bluetooth tethering status. This API is called by the QCMAP client BT PAN module to check the Bluetooth tethering status. @datatypes qcmap_msgr_bt_tethering_status_enum_v01 -# QCMAP_MSGR_BT_TETHERING_MODE_UP_V01 BT Tethering is UP -# QCMAP_MSGR_BT_TETHERING_MODE_DOWN_V01 BT Tethering is DOWN qcmap_bt_tethering_mode_enum_v01 -# QCMAP_MSGR_BT_MODE_LAN_V01 BT Tethering LAN Mode -# QCMAP_MSGR_BT_MODE_WAN_V01 BT Tethering WAN Mode qmi_error_type_v01 @param[out] bt_teth_mode get bt tethering Mode. @param[out] qmi_err_num Error code returned by the server. @param[out] bt_teth_status get bt tethering status. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean GetBTTetheringStatus ( qcmap_msgr_bt_tethering_status_enum_v01 *bt_teth_status, qmi_error_type_v01 *qmi_err_num, qcmap_bt_tethering_mode_enum_v01 *bt_teth_mode = NULL ); /*=========================================================================== FUNCTION SetIPAPacketThreshold() ===========================================================================*/ /** @ingroup qcmap_set_ipa_packet_threshold Set the packet threshold count to delay the time for the initial packets to flow through HW or SFE path. Until the packet threshold is reached packets will take the software path @datatypes qmi_error_type_v01 @param[in] pkt_limit The value to be set as packet limit. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies QCMobileAP must be enabled. */ boolean SetInitialPacketLimit ( uint32 pkt_limit, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetInitialPacketLimit() ===========================================================================*/ /** @ingroup qcmap_set_ipa_packet_threshold Get the packet threshold count to delay the time for the initial packets to flow through HW or SFE path. Until the packet threshold is reached packets will take the software path @datatypes qmi_error_type_v01 @param[in] pkt_limit The value that is set as packet limit. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies QCMobileAP must be enabled. */ boolean GetInitialPacketLimit ( uint32 *pkt_limit, qmi_error_type_v01 *qmi_err_num ); /*==================================================================== FUNCTION EnableSOCKSv5Proxy() =====================================================================*/ /** @ingroup section_qcmap_nat_alg_vpn_configuration @xreflabel{sec:enable_socksv5_proxy} Enables SOCKSv5 Proxy. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. FALSE upon failure. @dependencies None. */ boolean EnableSOCKSv5Proxy(qmi_error_type_v01 *qmi_err_num); /*==================================================================== FUNCTION DisableSOCKSv5Proxy() =====================================================================*/ /** @ingroup section_qcmap_nat_alg_vpn_configuration @xreflabel{sec:disable_socksv5_proxy} Disables the SOCKSv5 Proxy. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. FALSE upon failure. @dependencies None. */ boolean DisableSOCKSv5Proxy(qmi_error_type_v01 *qmi_err_num); /*=========================================================================== FUNCTION GetSOCKSv5Config() ===========================================================================*/ /** @ingroup section_qcmap_nat_alg_vpn @xreflabel{sec:get_SOCKSv5_config} Prints SOCKSv5 Proxy configuration parameters. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. FALSE upon failure. @dependencies None. */ boolean GetSOCKSv5Config(socksv5_configuration *configuration, qmi_error_type_v01 *qmi_err_num); /*=========================================================================== FUNCTION SetSOCKSv5Config() ===========================================================================*/ /** @ingroup section_qcmap_nat_alg_vpn @xreflabel{sec:get_SOCKSv5_config} Sets SOCKSv5 Proxy configuration parameters. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. FALSE upon failure. @dependencies None. */ boolean SetSOCKSv5Config(void *config, qcmap_socksv5_config_type_v01 config_type, qmi_error_type_v01 *qmi_err_num); /*=========================================================================== FUNCTION EnablePacketStats() ===========================================================================*/ /*! @ingroup qcmap_msgr_enable_packet_stats Enables Packet Stats Feature. This API is called by the QCMAP client to enable packet statistics. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean EnablePacketStats ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisablePacketStats() ===========================================================================*/ /*! @ingroup qcmap_msgr_disable_packet_stats Disables Packet Stats Feature. This API is called by the QCMAP client to disable packet statistics. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean DisablePacketStats ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION ResetPacketStats() ===========================================================================*/ /*! @ingroup qcmap_msgr_reset_packet_stats Resets Packet Stats Feature. This API is called by the QCMAP client to reset packet statistics. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean ResetPacketStats ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetPacketStatsStatus() ===========================================================================*/ /*! @ingroup qcmap_msgr_packet_stats_status Obtain Packet Stats Status. This API is called by the QCMAP client to get packet statistics state. @datatypes qcmap_msgr_packet_stats_status_enum_v01\n qmi_error_type_v01 @param[out] status packet stats status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies none @dependencies None. */ boolean GetPacketStatsStatus ( qcmap_msgr_packet_stats_status_enum_v01* status, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetVLANConfig() ===========================================================================*/ /** @ingroup section_set_VLAN_Config @xreflabel{sec:set_vlan_config} Sets VLAN Configuration. @datatypes -char local_iface[QCMAP_MAX_IFACE_NAME_SIZE_V01]; \n iface name -uint16_t vlan_id; vlan id to be set. @par qmi_error_type_v01 @param[in] vlan_config Sets the VLAN Config. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean SetVLANConfig ( qcmap_msgr_vlan_config_v01 config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetVLANConfig() ===========================================================================*/ /** @ingroup section_get_vlan_config @xreflabel{sec:get_vlan_config} Gets current vlan configuration. @datatypes qcmap_msgr_vlan_conf_t \n - uint32_t vlan_config_list_len; list length - qcmap_msgr_vlan_config_v01 vlan_config_list[QCMAP_MSGR_MAX_VLAN_ENTRIES_V01]; vlan config length @par qmi_error_type_v01 @param[out] mode Gets the VLAN Config. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. @newpage */ boolean GetVLANConfig ( qcmap_msgr_vlan_conf_t *vlan_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteVLANConfig() ===========================================================================*/ /** @ingroup section_delete_VLAN_Config @xreflabel{sec:delete_vlan_config} Deletes VLAN Configuration. @datatypes -char local_iface[QCMAP_MAX_IFACE_NAME_SIZE_V01]; \n iface name -uint16_t vlan_id; vlan id to be deleted. @par qmi_error_type_v01 @param[in] vlan_config Sets the VLAN Config. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean DeleteVLANConfig ( qcmap_msgr_vlan_config_v01 config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetUnmanagedL2TPState() ===========================================================================*/ /** @ingroup section_set_L2TP_state @xreflabel{sec:set_L2TP_state} Sets L2TP Enable/Disable config for unmanaged tunnels. @datatypes - uint8_t enable; - char config_file[QCMAP_MSGR_MAX_L2TP_FILE_NAME_LENGTH_V01]; @par qmi_error_type_v01 @param[in] l2tp_enable_config l2tp_enable_config to enable/disable l2tp. qcmap_msgr_l2tp_MTU_config_v01 MTU_config, to enable/disable MTU config qcmap_msgr_l2tp_TCP_MSS_config_v01 TCP_MSS_config to enable/disable TCP MSS @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean SetUnmanagedL2TPState ( qcmap_msgr_set_unmanaged_l2tp_state_config_v01 l2tp_enable_config, qcmap_msgr_l2tp_mtu_config_v01 MTU_config, qcmap_msgr_l2tp_TCP_MSS_config_v01 TCP_MSS_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetL2TPConfig() ===========================================================================*/ /** @ingroup section_set_L2TP_config_with_MTU @xreflabel{sec:set_L2TP_config_with_MTU} Sets L2TP Tunnel config by setting MTU size on underlying interfaces. @datatypes -qcmap_msgr_l2tp_mode_enum_v01 mode L2TP Mode of operation - uint32_t local_tunnel_id; local tunnel id - uint32_t peer_tunnel_id; peer tunel id - char local_iface[QCMAP_MAX_IFACE_NAME_SIZE_V01]; local iface name - qcmap_msgr_ip_family_enum_v01 ip_family; ip family - uint8_t peer_ipv6_addr[QCMAP_MSGR_IPV6_ADDR_LEN_V01]; peer ipv6 address - uint32_t peer_ipv4_addr; peer ipv4 address - qcmap_msgr_l2tp_encap_protocol_enum_v01 proto; encapsulation protocol - uint16_t local_udp_port; local udp port - uint16_t peer_udp_port; peer udp port - qcmap_msgr_l2tp_session_config_v01 session_config[QCMAP_MSGR_L2TP_MAX_SESSION_PER_TUNNEL_V01]; session config @par qmi_error_type_v01 @param[in] qcmap_msgr_l2tp_config_v01 l2tp_config to set l2tp config. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean SetL2TPConfig ( qcmap_msgr_l2tp_mode_enum_v01 mode, qcmap_msgr_l2tp_config_v01 l2tp_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetL2TPConfig() ===========================================================================*/ /** @ingroup section_get_l2tp_config @xreflabel{sec:get_l2tp_config} Gets current L2TP Configuration. @datatypes qcmap_msgr_l2tp_conf_t *l2tp_config, \n - uint32_t local_tunnel_id; local tunnel id - uint32_t peer_tunnel_id; peer tunel id - char local_iface[QCMAP_MAX_IFACE_NAME_SIZE_V01]; local iface name - qcmap_msgr_ip_family_enum_v01 ip_family; ip family - uint8_t peer_ipv6_addr[QCMAP_MSGR_IPV6_ADDR_LEN_V01]; peer ipv6 address - uint32_t peer_ipv4_addr; peer ipv4 address - qcmap_msgr_l2tp_encap_protocol_enum_v01 proto; encapsulation protocol - uint16_t local_udp_port; local udp port - uint16_t peer_udp_port; peer udp port - uint16_t mtu_size; mtu size - qcmap_msgr_l2tp_session_config_v01 session_config[QCMAP_MSGR_L2TP_MAX_SESSION_PER_TUNNEL_V01]; session config @par qmi_error_type_v01 @param[out] mode Gets the L2TP Config. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. @newpage */ boolean GetL2TPConfig ( qcmap_msgr_l2tp_conf_t *l2tp_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteL2TPTunnelConfig() ===========================================================================*/ /** @ingroup section_delete_L2TP_tunnel_config @xreflabel{sec:delete_L2TP_tunnel_config} Deletes L2TP Tunnel config. @datatypes -qcmap_msgr_delete_l2tp_config_v01 l2tp_Config L2TP Delete Config @par qmi_error_type_v01 @param[in] qcmap_msgr_delete_l2tp_config_v01 l2tp_config to set l2tp config. @param[out] qmi_err_num Error code returned by the server. @return TRUE -- Success. \n FALSE -- Failure. @dependencies None. */ boolean DeleteL2TPTunnelConfig ( qcmap_msgr_delete_l2tp_config_v01 l2tp_config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetPDNtoVLANMapping() ===========================================================================*/ /*! @ingroup qcmap_msgr_set_pdn_to_vlan_mapping Set PDN to map to specific VLAN. This API is called by the QCMAP client to set the PDN to map to a specific VLAN ID. @datatypes profile_handle_type_v01 \n uint32 \n qmi_error_type_v01 @param[out] status packet stats status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies none @dependencies None. */ boolean SetPDNtoVLANMapping ( profile_handle_type_v01 profile_handle, uint32 vlan_id, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetPDNtoVLANMappings() ===========================================================================*/ /*! @ingroup qcmap_msgr_get_pdn_to_vlan_mappings Get all PDN to VLAN mappings. Get list of all the PDNs and what VLAN ID's they map to. @datatypes qcmap_msgr_pdn_to_vlan_mapping_v01 \n qmi_error_type_v01 @param[out] status packet stats status. @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies none @dependencies None. */ boolean GetPDNtoVLANMappings ( qcmap_msgr_pdn_to_vlan_mapping_v01 *pdn_vlan_mappings, int *num_entries, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION EnableGSB() ===========================================================================*/ /** @ingroup qcmap_enable_gsb Enables the GSB. This function loads generic software bridge kernel module and sends the configuration to GSB @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean EnableGSB ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DisableGSB() ===========================================================================*/ /** @ingroup qcmap_disable_gsb Disables the GSB. This function unloads generic software bridge kernel module. @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DisableGSB ( qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION SetGSBConfig() ===========================================================================*/ /** @ingroup qcmap_set_gsb_config Sets GSB configuration. @datatypes qcmap_msgr_gsb_config_v01 qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean SetGSBConfig ( qcmap_msgr_gsb_config_v01 *config, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION GetGSBConfig() ===========================================================================*/ /** @ingroup qcmap_get_gsb_config Gets GSB configuration. @datatypes qcmap_msgr_gsb_config_v01 num_of_entries qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean GetGSBConfig ( qcmap_msgr_gsb_config_v01 *config, uint8 *num_of_entries, qmi_error_type_v01 *qmi_err_num ); /*=========================================================================== FUNCTION DeleteGSBConfig() ===========================================================================*/ /** @ingroup qcmap_delete_gsb_config Deletes configuration stored for GSB @datatypes qmi_error_type_v01 @param[out] qmi_err_num Error code returned by the server. @return TRUE upon success. \n FALSE upon failure. @dependencies QCMobileAP must be enabled. */ boolean DeleteGSBConfig ( char* if_name, qmi_error_type_v01 *qmi_err_num ); private: boolean qcmap_msgr_enable; /* Whether the QCMAP Connection Manager is enabled. */ }; #endif /* QCMAP_CLIENT_H */