Linux SDK (lite-qmi)  MBPL_SDK_R25_ENG3
unpack_wds_GetDefaultSettings_t Struct Reference

#include <wds.h>

Data Fields

uint8_t Profile_name_size
 
char Profile_name [WDS_MAX_STRING]
 
uint8_t Pdp_type
 
uint8_t Pdp_hdr_compression_type
 
uint8_t Pdp_data_compression_type
 
uint8_t Apn_name_size
 
char Apn_name [WDS_MAX_STRING]
 
uint32_t Primary_DNS_IPv4_address_preference
 
uint32_t Secondary_DNS_IPv4_address_preference
 
struct UmtsRequestedMinQos_t umtsRequestedQos
 
struct UmtsRequestedMinQos_t umtsMinimumQos
 
struct GprsRequestedMinQos_t gprsRequestedQos
 
struct GprsRequestedMinQos_t gprsMinimumQos
 
uint8_t UserNameSize
 
char UserName [WDS_MAX_STRING]
 
uint8_t PasswordSize
 
char Password [WDS_MAX_STRING]
 
uint8_t Authentication_preference
 
uint32_t Ipv4_address_preference
 
uint8_t Pcscf_addr_using_pco
 
uint8_t Pdp_access_control_flag
 
uint8_t Pcscf_addr_using_dhcp
 
uint8_t Im_cn_flag
 
struct TrafficFlow_t trafficFlow
 
struct TrafficFlow_t tftId2Parameters
 
uint8_t Pdp_context
 
uint8_t Secondary_flag
 
uint8_t Primary_id
 
uint8_t Ipv6_address_preference [WDS_QMI_MSG_IPV6_LEN]
 
struct UmtsReqQoSWithSigInd_t umtsReqQoSWithSigInd
 
struct UmtsReqQoSWithSigInd_t umtsMinQoSWithSigInd
 
uint8_t Primary_dns_ipv6_address_preference [WDS_QMI_MSG_PRIMARY_DNSV6_LEN]
 
uint8_t Secondary_dns_ipv6_address_preference [WDS_QMI_MSG_SECONDARY_DNSV6_LEN]
 
uint8_t Addr_allocation_preference
 
struct SGpp_Lte_Qos_Param_t s3Gpp_Lte_Qos_Param
 
uint8_t Apn_disabled_flag
 
uint32_t Pdn_inactivity_timeout
 
uint8_t Apn_class
 
uint8_t Attach_wo_pdn
 
uint8_t Pdn_label_3gpp_size
 
char Pdn_label_3gpp [WDS_LABEL_3GPP_MAX_STRING]
 
struct EapAuthentication_t eapAuthentication
 
uint8_t Rqos_support
 
uint8_t Mhipv6_support
 
uint8_t Always_on_pdu
 
uint8_t Negotiate_dns_server_preference
 
uint32_t Ppp_session_close_timer_DO
 
uint32_t Ppp_session_close_timer_1x
 
uint8_t Allow_linger
 
uint16_t Lcp_ack_timeout
 
uint16_t Ipcp_ack_timeout
 
uint16_t Auth_timeout
 
uint8_t Lcp_creq_retry_count
 
uint8_t Ipcp_creq_retry_count
 
uint8_t Auth_retry_count
 
uint8_t Auth_protocol
 
uint8_t User_id_size
 
char User_id [WDS_MAX_STRING]
 
uint8_t Auth_Password_size
 
char Auth_Password [255]
 
uint8_t Data_rate
 
uint32_t App_type
 
uint8_t Data_mode
 
uint8_t App_priority
 
uint8_t Apn_string_size
 
char Apn_string [WDS_MAX_STRING]
 
uint8_t Pdn_type
 
uint8_t Is_pcscf_address_needed
 
uint32_t Primary_v4_dns_address
 
uint32_t Secondary_v4_dns_address
 
uint32_t Primary_v6_dns_address
 
uint8_t Secondary_v6_dns_address [WDS_QMI_MSG_SECONDARY_DNSV6_LEN]
 
uint8_t Rat_type
 
uint8_t Apn_enabled_3gpp2
 
uint32_t Pdn_inactivity_timeout_3gpp2
 
uint8_t Apn_class_3gpp2
 
uint16_t Extended_error_code
 
swi_uint256_t ParamPresenceMask
 

Detailed Description

Reads the default profile settings from the device. The default profile is used to establish an auto connect data session.

Parameters
Profile_name_size
  • profile name buffer size
Profile_name
  • One or more bytes describing the profile. The description is a user-defined name for the profile. QMI_ERR_ARG_TOO_LONG is returned if the profile_name is too long.
  • Bit to check in ParamPresenceMask - 0x10
Pdp_type
  • Specifies the type of data payload exchanged over the airlink when the packet data session is established with this profile. Values: WDS_PDP_TYPE_PDP_IPV4 (0x00) - PDP-IP (IPv4) WDS_PDP_TYPE_PDP_PPP (0x01) - PDP-PPP WDS_PDP_TYPE_PDP_IPV6 (0x02) - PDP-IPv6 WDS_PDP_TYPE_PDP_IPV4V6 (0x03) - PDP-IPv4 and IPv6 WDS_PDP_TYPE_PDP_NON_ IP (0x04) - PDP-NON IP
  • Bit to check in ParamPresenceMask - 0x11
Pdp_hdr_compression_type
  • PDP Header Compression Type Values: WDS_PDP_HDR_COMPR_TYPE_OFF (0x00) - PDP header compression is off WDS_PDP_HDR_COMPR_TYPE_MANUFACTURER_PREF (0x01) - Manufacturer preferred compression WDS_PDP_HDR_COMPR_TYPE_RFC_1144 (0x02) - PDP header compression based on RFC 1144 WDS_PDP_HDR_COMPR_TYPE_RFC_2507 (0x03) - PDP header compression based on RFC 2507 WDS_PDP_HDR_COMPR_TYPE_RFC_3095 (0x04) - PDP header compression based on RFC 3095
  • Bit to check in ParamPresenceMask - 0x12
Pdp_data_compression_type
  • PDP Data Compression Type Values: WDS_PDP_DATA_COMPR_TYPE_OFF (0x00) - PDP data compression is off WDS_PDP_DATA_COMPR_TYPE_MANUFACTURER_PREF (0x01) - Manufacturer preferred compression WDS_PDP_DATA_COMPR_TYPE_V42 (0x02) - V.42BIS data compression WDS_PDP_DATA_COMPR_TYPE_V44 (0x03) - V.44 data compression
  • Bit to check in ParamPresenceMask - 0x13
Apn_name_size
  • APN name buffer size
Apn_name
  • Context Access Point Node (APN) Name String parameter that is a logical name used to select the GGSN and external packet data network. If the value is NULL or omitted, the subscription default value is requested. QMI_ERR_ARG_TOO_LONG is returned if the APN name is too long.
  • Bit to check in ParamPresenceMask - 0x14
Primary_DNS_IPv4_address_preference
  • Used as a preference during negotiation with the network; if not specified, the wireless device attempts to obtain the DNS address automatically from the network. The negotiated value is provided to the host via DHCP.
  • Bit to check in ParamPresenceMask - 0x15
Secondary_DNS_IPv4_address_preference
  • Used as a preference during negotiation with the network; if not specified, the wireless device attempts to obtain the DNS address automatically from the network. The negotiated value is provided to the host via DHCP.
  • Bit to check in ParamPresenceMask - 0x16
umtsRequestedQos
  • UMTS Requested QoS
  • Bit to check in ParamPresenceMask - 0x17
umtsMinimumQos
  • UMTS Minimum QoS
  • Bit to check in ParamPresenceMask - 0x18
gprsRequestedQos
  • GPRS Requested QoS
  • Bit to check in ParamPresenceMask - 0x19
gprsMinimumQos
  • GPRS minimum QoS
  • Bit to check in ParamPresenceMask - 0x1A
UserNameSize[in]
  • Username buffer size
UserName
  • Username
  • Bit to check in ParamPresenceMask - 0x1B
PasswordSize[in]
  • Password buffer size
Password
  • Password
  • Bit to check in ParamPresenceMask - 0x1C
Authentication_preference
  • Authentication Preference Bitmap that indicates the authentication algorithm preference.
    • Values:
      • Bit 0 - PAP preference:
        • 0 - PAP is never performed
        • 1 - PAP can be performed
      • Bit 1 - CHAP preference:
        • 0 - CHAP is never performed
        • 1 - CHAP can be performed
      • All other bits are reserved and are ignored. They must be set to zero by the client. If more than one bit is set, the device decides which authentication procedure is performed while setting up the data session. For example, the device might have a policy to select the most secure authentication mechanism.
  • Bit to check in ParamPresenceMask - 0x1D
Ipv4_address_preference
  • IPv4 Address Preference
    • Preferred IPv4 address assigned to the TE - The actual assigned address is negotiated with the network and can differ from this value. If not specified, the IPv4 Address is obtained automatically from the network. The assigned value is provided to the host via DHCP.
  • Bit to check in ParamPresenceMask - 0x1E
Pcscf_addr_using_pco
  • PCSCF Address Using PCO Flag
    • Values:
      • 1 - TRUE - Request PCSCF address using PCO
      • 0 - FALSE - Do not request (default)
  • Bit to check in ParamPresenceMask - 0x1F
Pdp_access_control_flag
  • PDP Access Control Flag
    • Values:
      • WDS_PDP_ACCESS_CONTROL_NONE (0x00) - None
      • WDS_PDP_ACCESS_CONTROL_REJECT (0x01) - Reject
      • WDS_PDP_ACCESS_CONTROL_PERMISSION (0x02) - Permission
  • Bit to check in ParamPresenceMask - 0x20
Pcscf_addr_using_dhcp
  • PCSCF Address Using DHCP
    • Values:
      • 1 - TRUE - Request PCSCF address using DHCP
      • 0 - FALSE - Do not request (default)
  • Bit to check in ParamPresenceMask - 0x21
Im_cn_flag
  • IM CN Flag
    • Values:
      • 1 - TRUE - Request IM CN flag for this profile
      • 0 - FALSE - Do not request IM CN flag for this profile
  • Bit to check in ParamPresenceMask - 0x22
trafficFlow
  • Traffic Flow Template (TFT) ID1 Parameters
  • Bit to check in ParamPresenceMask - 0x23
tftId2Parameters
  • Traffic Flow Template ID2 Parameters
  • Bit to check in ParamPresenceMask - 0x24
Pdp_context
  • PDP Context Number
  • Bit to check in ParamPresenceMask - 0x25
Secondary_flag
  • PDP Context Secondary Flag
    • Values:
      • 1 - TRUE - This is the secondary profile
      • 0 - FALSE - This is not the secondary profile
  • Bit to check in ParamPresenceMask - 0x26
Primary_id
  • PDP context number primary ID.
  • Bit to check in ParamPresenceMask - 0x27
Ipv6_address_preference
  • The preferred IPv6 address to assign to the TE; the actual assigned address is negotiated with the network and can differ from this value. If not specified, the IPv6 address is obtained automatically from the network.
  • Bit to check in ParamPresenceMask - 0x28
umtsReqQoSWithSigInd
  • UMTS requested QoS With Signaling Indication
  • Bit to check in ParamPresenceMask - 0x29
umtsMinQoSWithSigInd
  • UMTS Minimum QoS With Signaling Indication
  • Bit to check in ParamPresenceMask - 0x2A
Primary_dns_ipv6_address_preference
  • Primary DNS IPv6 Address Preference
  • Used as a preference during negotiation with the network; if not specified, the wireless device attempts to obtain the DNS address automatically from the network. The negotiated value is provided to the host via DHCP.
  • Bit to check in ParamPresenceMask - 0x2B
Secondary_dns_ipv6_address_preference
  • Secondary DNS IPv6 Address Preference
  • Used as a preference during negotiation with the network; if not specified, the wireless device attempts to obtain the DNS address automatically from the network. The negotiated value is provided to the host via DHCP.
  • Bit to check in ParamPresenceMask - 0x2C
Addr_allocation_preference
  • DHCP/NAS Preference
  • Indicates the address allocation preference. Values:
    • WDS_ADDR_ALLOC_PREF_NAS(0x00) - Use NAS signaling for address allocation
    • WDS_ADDR_ALLOC_PREF_DHCP(0x01) - Use DHCP for address allocation
  • Bit to check in ParamPresenceMask - 0x2D
3Gpp_Lte_Qos_Param
  • 3GPP LTE QoS Parameters
  • Bit to check in ParamPresenceMask - 0x2E
Apn_disabled_flag
  • APN Disabled Flag
  • Setting this flag disables the use of this profile for making data calls. Any data call with this profile fails locally.
    • Values:
      • 0 - FALSE (default)
      • 1 - TRUE
  • Bit to check in ParamPresenceMask - 0x2F
Pdn_inactivity_timeout
  • PDN Inactivity Timeout
    • Duration of the inactivity timer in seconds. When a PDP context or PDN connection is inactive (that is, no data Rx or Tx) for this duration of time, PDP context or PDN connection is disconnected. The default setting of zero is treated as an infinite value.
  • Bit to check in ParamPresenceMask - 0x30
Apn_class
  • An opaque, numeric identifier representing the APN in the profile. This can be transparently set for any profile and queried later.
  • Bit to check in ParamPresenceMask - 0x31
Attach_wo_pdn
  • Attach Without PDN
  • Indicates whether attach without PDN capability is supported.
    • Values:
      • 1 - Attach without PDN is supported
      • 0 - Attach without PDN is not supported (default)
  • Bit to check in ParamPresenceMask - 0x49
Pdn_label_3gpp_size
  • size of pPdn_label_3gpp
Pdn_label_3gpp
  • PDN Label for 3GPP
  • Logical name used to map the APN name for selecting the packet data network. Maximum length allowed is 100 bytes.
  • Bit to check in ParamPresenceMask - 0x4A
EapAuthentication_t
  • EAP Authentication
  • Bit to check in ParamPresenceMask - 0x4B
Rqos_support
  • Reflective QoS Support
    • Values:
      • 1 - TRUE - Reflective QoS supported
      • 0 - FALSE - Not supported (default)
  • Bit to check in ParamPresenceMask - 0x4C
Mhipv6_support
  • Multi-homed IPV6 PDU Session Support
    • Values:
      • 1 - TRUE - Multi-homed IPv6 PDU session supported
      • 0 - FALSE - Not supported (default)
  • Bit to check in ParamPresenceMask - 0x4D
Always_on_pdu
  • Always on PDU Session
    • Values:
      • 1 - TRUE - Always on PDU
      • 0 - FALSE - Not supported (default)
  • Bit to check in ParamPresenceMask - 0x4E
Negotiate_dns_server_preference
  • Negotiate DNS Server Preference
    • Values:
      • 1 - TRUE - Request DNS address from the PDSN (default)
      • 0 - FALSE - Do not request DNS addresses from the PDSN
  • Bit to check in ParamPresenceMask - 0x90
Ppp_session_close_timer_DO
  • PPP Session Close Timer for DO
  • Timer value (in seconds) on the DO indicating how long the PPP session lingers before closing down.
  • Bit to check in ParamPresenceMask - 0x91
Ppp_session_close_timer_1x
  • The timer value (in seconds) on 1X indicating how long the PPP session lingers before closing.
  • Bit to check in ParamPresenceMask - 0x92
Allow_linger
  • Allow/Disallow Lingering of Interface
    • Values:
      • 1 - TRUE - Allow lingering
      • 0 - FALSE - Do not allow lingering
  • Bit to check in ParamPresenceMask - 0x93
Lcp_ack_timeout
  • LCP ACK Timeout
    • Value of LCP ACK timeout in milliseconds.
  • Bit to check in ParamPresenceMask - 0x94
Ipcp_ack_timeout
  • IPCP ACK Timeout
  • Value of IPCP ACK timeout in milliseconds.
  • Bit to check in ParamPresenceMask - 0x95
Auth_timeout
  • AUTH Timeout
  • Value of authentication timeout in milliseconds.
  • Bit to check in ParamPresenceMask - 0x96
Lcp_creq_retry_count
  • LCP Configuration Request Retry Count Value.
  • Bit to check in ParamPresenceMask - 0x97
Ipcp_creq_retry_count
  • IPCP configuration request retry count value.
  • Bit to check in ParamPresenceMask - 0x98
Auth_retry_count
  • Authentication retry count value.
  • Bit to check in ParamPresenceMask - 0x99
Auth_protocol
  • Authentication Protocol
    • Values:
      • WDS_PROFILE_AUTH_PROTOCOL_NONE (0) - None
      • WDS_PROFILE_AUTH_PROTOCOL_PAP (1) - PAP
      • WDS_PROFILE_AUTH_PROTOCOL_CHAP (2) - CHAP
      • WDS_PROFILE_AUTH_PROTOCOL_PAP_CHAP (3) - PAP or CHAP
  • Bit to check in ParamPresenceMask - 0x9A
User_id_size
  • user_id size
User_id
  • User ID used during data network authentication; maximum length allowed is 127 bytes. QMI_ERR_ARG_TOO_LONG is returned if the storage on the wireless device is insufficient in size to hold the value.
  • Bit to check in ParamPresenceMask - 0x9B
Auth_Password_size
  • Authentication Password size
Auth_Password
  • Authentication Password
  • Password used during data network authentication; maximum length allowed is 127 bytes. QMI_ERR_ARG_TOO_LONG is returned if the storage on the wireless device is insufficient in size to hold the value.
  • Bit to check in ParamPresenceMask - 0x9C
Data_rate
  • Data rate
    • Values:
      • WDS_PROFILE_DATA_RATE_ LOW(0) - Low (Low speed Service Options (SO15) only)
      • WDS_PROFILE_DATA_RATE_MEDIUM (1) - Medium (SO33 + low R-SCH)
      • WDS_PROFILE_DATA_RATE_HIGH (2) - High (SO33 + high R-SCH) Note: Default is 2.
  • Bit to check in ParamPresenceMask - 0x9D
App_type
  • Application Type
    • Values:
      • WDS_PROFILE_APP_TYPE_DEFAULT (0x00000001) - Default application type
      • WDS_PROFILE_APP_TYPE_ LBS (0x00000020) - LBS application type
      • WDS_PROFILE_APP_TYPE_TETHERED (0x00000040) - Tethered application type
      • Note: Application type value in a profile cannot be modified. It can only be used to search for the profile ID numbers that have the specified application type.
  • Bit to check in ParamPresenceMask - 0x9E
Data_mode
  • Data Mode
    • Values:
      • WDS_PROFILE_DATA_MODE_CDMA_HDR (0) - CDMA or HDR (Hybrid 1X and 1xEV-DO)
      • WDS_PROFILE_DATA_MODE_CDMA (1) - CDMA only (1X only)
      • WDS_PROFILE_DATA_MODE_HDR (2) - HDR only (1xEV-DO only)
  • Bit to check in ParamPresenceMask - 0x9F
App_priority
  • Application Priority
    • Numerical one byte value defining the application priority; higher value means higher priority. Note: Application priority value in a profile cannot be modified. It is listed for future extensibility of profile ID search based on application priority. Note: Default is 0.
  • Bit to check in ParamPresenceMask - 0xA0
Apn_string_size
  • APN Name character count
Apn_string
  • APN String
    • String representing the APN; maximum length allowed is 100 bytes. QMI_ERR_ARG_TOO_LONG is returned if the APN name is too long.
  • Bit to check in ParamPresenceMask - 0xA1
Pdn_type
  • PDN Type
    • Values:
      • WDS_PROFILE_PDN_TYPE_ IPV4 (0) - IPv4 PDN type
      • WDS_PROFILE_PDN_TYPE_ IPV6 (1) - IPv6 PDN type
      • WDS_PROFILE_PDN_TYPE_IPV4_IPV6 (2) - IPv4 or IPv6 PDN type
      • WDS_PROFILE_PDN_TYPE_UNSPECIFIED (3) - Unspecified PDN type (implying no preference)
  • Bit to check in ParamPresenceMask - 0xA2
Is_pcscf_address_needed
  • Is PCSCF Address Needed
  • Used to control whether the PCSCF address is requested from PDSN.
    • Values:
      • 1 - TRUE - Request for PCSCF value from the PDSN
      • 0 - FALSE - Do not request for PCSCF value from the PDSN
  • Bit to check in ParamPresenceMask - 0xA3
Primary_v4_dns_address
  • IPv4 Primary DNS Address
  • Primary IPv4 DNS address that can be statically assigned to the UE.
  • Bit to check in ParamPresenceMask - 0xA4
Secondary_v4_dns_address
  • IPv4 Secondary DNS Address
  • Secondary IPv4 DNS address that can be statically assigned to the UE.
  • Bit to check in ParamPresenceMask - 0xA5
Primary_v6_dns_address
  • Primary IPv6 DNS address that can be statically assigned to the UE.
  • Bit to check in ParamPresenceMask - 0xA6
Secondary_v6_dns_address
  • Secondary IPv6 DNS address that can be statically assigned to the UE.
  • Bit to check in ParamPresenceMask - 0xA7
Rat_type
  • RAT Type
    • Values:
      • WDS_RAT_TYPE_HRPD (1) - HRPD
      • WDS_RAT_TYPE_EHRPD (2) - EHRPD
      • WDS_RAT_TYPE_HRPD_EHRPD (3) - HRPD_EHRPD
  • Bit to check in ParamPresenceMask - 0xA8
Apn_enabled_3gpp2
  • APN Enabled
    • Specifies whether the APN in that profile is enabled or disabled. If the APN is disabled, the data call cannot be established using that APN.
    • Values:
      • 1 - Enabled (default)
      • 0 - Disabled
  • Bit to check in ParamPresenceMask - 0xA9
Pdn_inactivity_timeout_3gpp2
  • PDN Inactivity Timeout
    • Duration of inactivity timer in minutes. When a PDP context or PDN connection is inactive (that is, no data Rx or Tx) for this duration of time, the PDP context or PDN connection is disconnected. The default setting of zero is treated as an infinite value.
  • Bit to check in ParamPresenceMask - 0xAA
Apn_class_3gpp2
  • APN Class
    • Opaque, numeric identifier representing the APN in the profile. This can be transparently set for any profile and queried later.
  • Bit to check in ParamPresenceMask - 0xAB
Extended_error_code
  • Profile Extended Error Code
    • Extended error code received from the DS profile subsystem. These error codes are explained in Appendix C.
  • Bit to check in ParamPresenceMask - 0xE0
ParamPresenceMask
  • bitmask representation to indicate valid parameters.

The documentation for this struct was generated from the following file: