ipcm_pub/connection_settings_api/inc/cmpluginwlandef.h
changeset 20 9c97ad6591ae
parent 0 5a93021fdf25
child 58 83ca720e2b9a
equal deleted inserted replaced
18:fcbbe021d614 20:9c97ad6591ae
     1 /*
     1 /*
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
     2 * Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    13 *
    13 *
    14 * Description:  ?description
    14 * Description:
       
    15 * WLAN specific enums.
    15 *
    16 *
    16 */
    17 */
    17 
    18 
    18 #ifndef CMPLUGIN_WLAN_DEF_H
    19 #ifndef CMPLUGIN_WLAN_DEF_H
    19 #define CMPLUGIN_WLAN_DEF_H
    20 #define CMPLUGIN_WLAN_DEF_H
    23 /**  ECOM interface UID */
    24 /**  ECOM interface UID */
    24 const TUint KUidWlanBearerType = 0x10281BB1;
    25 const TUint KUidWlanBearerType = 0x10281BB1;
    25 
    26 
    26 namespace CMManager
    27 namespace CMManager
    27     {
    28     {
    28     /** enumerations for WLAN network modes */
    29     /** Enumerations for WLAN network modes. */
    29     enum TWlanNetMode
    30     enum TWlanNetMode
    30         {
    31         {
    31         EAdhoc       = 0,   ///< Ad-Hoc mode
    32         EAdhoc       = 0,   ///< Ad-Hoc mode
    32         EInfra       = 1    ///< Infrastructure mode
    33         EInfra       = 1    ///< Infrastructure mode
    33         };
    34         };
    34         
    35 
    35     /** enumerations for WLAN security modes 
    36     /** Enumerations for WLAN security modes.
    36      ** It's possible to extend this enumeration */
    37      ** It's possible to extend this enumeration. */
    37     enum TWlanSecMode
    38     enum TWlanSecMode
    38         {
    39         {
    39         EWlanSecModeOpen    = 1,    ///< Open security mode
    40         EWlanSecModeOpen    = 1,    ///< Open security mode
    40         EWlanSecModeWep     = 2,    ///< WEP security mode
    41         EWlanSecModeWep     = 2,    ///< WEP security mode
    41         EWlanSecMode802_1x  = 4,    ///< 802.1x security mode
    42         EWlanSecMode802_1x  = 4,    ///< 802.1x security mode
    42         EWlanSecModeWpa     = 8,    ///< WPA security mode
    43         EWlanSecModeWpa     = 8,    ///< WPA security mode
    43         EWlanSecModeWpa2    = 16,   ///< WPA2 security mode
    44         EWlanSecModeWpa2    = 16,   ///< WPA2 security mode
    44         EWlanSecModeWAPI    = 32    ///< WAPI security mode
    45         EWlanSecModeWAPI    = 32    ///< WAPI security mode
    45         };
    46         };
    46 
    47 
    47     /** Wlan specific connection method attributes */
    48     /** Enumerations for WLAN authentication modes.
       
    49      ** It's possible to extend this enumeration. */
       
    50     enum TWlanAuthMode
       
    51         {
       
    52         EWlanAuthModeOpen   = 0,
       
    53         EWlanAuthModeShared = 1
       
    54         };
       
    55 
       
    56     /** Enumerations for WAPI pre-shared key format (ascii, hex).
       
    57      ** It's possible to extend this enumeration. */
       
    58     enum TWlanWapiPskFormat
       
    59         {
       
    60         EWlanWapiPskFormatAscii = 0,
       
    61         EWlanWapiPskFormatHex
       
    62         };
       
    63 
       
    64     /** Enumerations for the WEP key indexes.
       
    65      ** It's possible to extend this enumeration. */
       
    66     enum TWepKeyIndex
       
    67         {
       
    68         EWepKeyIndex1 = 0, // Key number 1
       
    69         EWepKeyIndex2,     // Key number 2
       
    70         EWepKeyIndex3,     // Key number 3
       
    71         EWepKeyIndex4      // Key number 4
       
    72         };
       
    73 
       
    74     /** WLAN specific connection method attributes. */
    48     enum TConnectionMethodWlanSpecificAttributes
    75     enum TConnectionMethodWlanSpecificAttributes
    49         {
    76         {
    50         /**
    77         /**
    51         * Comma separated list of network protocols, e.g. "PPP".
    78         * Comma separated list of network protocols, e.g. "PPP".
    52         * ( String - default: None)
    79         * ( String - default: None)
    54         EWlanIfNetworks = KLanBaseIfNetworks,
    81         EWlanIfNetworks = KLanBaseIfNetworks,
    55 
    82 
    56         /**
    83         /**
    57         * IP net mask of interface.
    84         * IP net mask of interface.
    58         * ( String - default: None)
    85         * ( String - default: None)
    59         */        
    86         */
    60         EWlanIpNetMask,
    87         EWlanIpNetMask,
    61             
    88 
    62         /**
    89         /**
    63         * IP address of gateway
    90         * IP address of gateway.
    64         * ( String - default: None)
    91         * ( String - default: None)
    65         */
    92         */
    66         EWlanIpGateway,
    93         EWlanIpGateway,
    67             
    94 
    68         /**
    95         /**
    69         * Get IP addresses (for EPOC) from server?
    96         * Get IP addresses (for EPOC) from server?
    70         * ( TBool - default: None)
    97         * ( TBool - default: None)
    71         */
    98         */
    72         EWlanIpAddrFromServer,
    99         EWlanIpAddrFromServer,
    73         
   100 
    74         /**
   101         /**
    75         * IP address of EPOC.
   102         * IP address of EPOC.
    76         * ( String - default: None)
   103         * ( String - default: None)
    77         */
   104         */
    78         EWlanIpAddr,
   105         EWlanIpAddr,
    79         
   106 
    80         /**
   107         /**
    81         * Get DNS addresses from server?
   108         * Get DNS addresses from server?
    82         * ( TBool - default: None)
   109         * ( TBool - default: None)
    83         */
   110         */
    84         EWlanIpDNSAddrFromServer,
   111         EWlanIpDNSAddrFromServer,
    86         /**
   113         /**
    87         * IP Address of primary name server.
   114         * IP Address of primary name server.
    88         * ( String - default: None)
   115         * ( String - default: None)
    89         */
   116         */
    90         EWlanIpNameServer1,
   117         EWlanIpNameServer1,
    91             
   118 
    92         /**
   119         /**
    93         * IP Address of secondary name server.
   120         * IP Address of secondary name server.
    94         * ( String - default: None)
   121         * ( String - default: None)
    95         */
   122         */
    96         EWlanIpNameServer2,
   123         EWlanIpNameServer2,
    97         
   124 
    98         /**
   125         /**
    99         * Get IP6 DNS addresses from server?
   126         * Get IP6 DNS addresses from server?
   100         * ( TBool - default: None)
   127         * ( TBool - default: None)
   101         */
   128         */
   102         EWlanIp6DNSAddrFromServer,
   129         EWlanIp6DNSAddrFromServer,
   103         
   130 
   104         /**
   131         /**
   105         * IP6 Address of primary name server.
   132         * IP6 Address of primary name server.
   106         * ( String - default: None)
   133         * ( String - default: None)
   107         */
   134         */
   108         EWlanIp6NameServer1,
   135         EWlanIp6NameServer1,
   109         
   136 
   110         /**
   137         /**
   111         * IP6 Address of secondary name server.
   138         * IP6 Address of secondary name server.
   112         * ( String - default: None)
   139         * ( String - default: None)
   113         */
   140         */
   114         EWlanIp6NameServer2,
   141         EWlanIp6NameServer2,
   115         
   142 
   116         /**
   143         /**
   117         * IP address valid from this time, used to store 
   144         * IP address valid from this time, used to store
   118         * dynamically assigned address lease info.
   145         * dynamically assigned address lease info.
   119         * ( String - default: None)
   146         * ( String - default: None)
   120         */
   147         */
   121         EWlanIpAddrLeaseValidFrom,
   148         EWlanIpAddrLeaseValidFrom,
   122             
   149 
   123         /**
   150         /**
   124         * IP address valid for use until this time, used to store
   151         * IP address valid for use until this time, used to store
   125         * dynamically assigned address lease info.
   152         * dynamically assigned address lease info.
   126         * ( String - default: None)
   153         * ( String - default: None)
   127         */
   154         */
   128         EWlanIpAddrLeaseValidTo,
   155         EWlanIpAddrLeaseValidTo,
   129             
   156 
   130         /**
   157         /**
   131         * Name of the ECOM configuration daemon manager component. 
   158         * Name of the ECOM configuration daemon manager component.
   132         * This component interfaces with the server identified in 
   159         * This component interfaces with the server identified in
   133         * ISP_CONFIG_DAEMON_NAME. If specified, ISP_CONFIG_DAEMON_NAME 
   160         * ISP_CONFIG_DAEMON_NAME. If specified, ISP_CONFIG_DAEMON_NAME
   134         * should also be specified. 
   161         * should also be specified.
   135         * ( String - default: None)
   162         * ( String - default: None)
   136         */
   163         */
   137         EWlanConfigDaemonManagerName,
   164         EWlanConfigDaemonManagerName,
   138             
   165 
   139         /**
   166         /**
   140         * Name of the configuration daemon server. 
   167         * Name of the configuration daemon server.
   141         * This server is used to provide further configuration for 
   168         * This server is used to provide further configuration for
   142         * a connection, e.g. dynamic IP address assignment. 
   169         * a connection, e.g. dynamic IP address assignment.
   143         * If specified, ISP_CONFIG_DAEMON_MANAGER_NAME should also 
   170         * If specified, ISP_CONFIG_DAEMON_MANAGER_NAME should also
   144         * be specified.
   171         * be specified.
   145         * ( String - default: None)
   172         * ( String - default: None)
   146         */
   173         */
   147         EWlanConfigDaemonName,
   174         EWlanConfigDaemonName,
   148             
   175 
   149         /**
   176         /**
   150         * Name of the WLAN Service Extension table.
   177         * Name of the WLAN Service Extension table.
   151         * ( String - default: None)
   178         * ( String - default: None)
   152         */
   179         */
   153         EWlanServiceExtensionTableName,
   180         EWlanServiceExtensionTableName,
   154             
   181 
   155         /**
   182         /**
   156         * The record ID of the linked WLAN Service Extension record in the
   183         * The record ID of the linked WLAN Service Extension record in the
   157         * WLAN Service Extension table.
   184         * WLAN Service Extension table.
   158         * ( TUint32 - default: None)
   185         * ( TUint32 - default: None)
   159         */
   186         */
   160         EWlanServiceExtensionTableRecordId,
   187         EWlanServiceExtensionTableRecordId,
   161         
   188 
   162         /**
   189         /**
   163         * Marks the beginning of WLAN specific attributes.
   190         * Marks the beginning of WLAN specific attributes.
   164         */
   191         */
   165         EWlanSpecificAttributes = 30000,
   192         EWlanSpecificAttributes = 30000,
   166             
   193 
   167         /**
   194         /**
   168         * The record ID to which IAP record these settings belong to.
   195         * The record ID to which IAP record these settings belong to.
   169         * ( TUint32 - default: None)
   196         * ( TUint32 - default: None)
   170         */
   197         */
   171         EWlanServiceId = 30100,
   198         EWlanServiceId = 30100,
   172             
   199 
   173         /**
   200         /**
   174         * The connection mode. This can be either Ad-hoc or infrastructure.
   201         * The connection mode. This can be either Ad-hoc or infrastructure.
   175         * TWlanNetMode enum is to be used.
   202         * TWlanNetMode enum is to be used.
   176         * ( TUint32 - default: EInfra )
   203         * ( TUint32 - default: EInfra )
   177         */
   204         */
   178         EWlanConnectionMode,
   205         EWlanConnectionMode,
   179             
   206 
   180         /**
   207         /**
   181         * The SSID of this WLAN connection.
   208         * The SSID of this WLAN connection.
   182         * ( String - default: None)
   209         * ( String - default: None)
   183         */
   210         */
   184         EWlanSSID,
   211         EWlanSSID,
   185             
   212 
   186         /**
   213         /**
   187         * Used SSID.
   214         * Used SSID.
   188         * ( String - default: None)
   215         * ( String - default: None)
   189         */
   216         */
   190         EWlanUsedSSID,
   217         EWlanUsedSSID,
   191             
   218 
   192         /**
   219         /**
   193         * The security mode of this WLAN connection. It is a TWlanSecMode enum.
   220         * The security mode of this WLAN connection. It is a TWlanSecMode enum.
   194         * ( TUint32 - default: EWlanSecModeOpen )
   221         * ( TUint32 - default: EWlanSecModeOpen )
   195         */
   222         */
   196         EWlanSecurityMode,
   223         EWlanSecurityMode,
   197             
   224 
   198         /**
   225         /**
   199         * Authentication type: none, wep, wpa, wpapresharedkey
   226         * Authentication mode: Defined in TWlanAuthMode.
   200         * ( TUint32 - default: None )
   227         * ( TUint32 - default: EWlanAuthModeOpen )
   201         */
   228         */
   202         EWlanAuthenticationMode,
   229         EWlanAuthenticationMode,
   203             
   230 
   204         /**
   231         /**
   205         * Gives whether it should scan for the SSID.
   232         * Gives whether it should scan for the SSID.
   206         * (TBool - default: EFalse )
   233         * (TBool - default: EFalse )
   207         */
   234         */
   208         EWlanScanSSID,
   235         EWlanScanSSID,
   209         
   236 
   210         /**
   237         /**
   211         * This is the channel ID in ad-hoc network mode
   238         * This is the channel ID in ad-hoc network mode
   212         * ( TUint32 - default: EAdhocAutomatic, if set to EAdhocUserDefined default = 7 )
   239         * ( TUint32 - default: EAdhocAutomatic, if set to EAdhocUserDefined default = 7 )
   213         */
   240         */
   214         EWlanChannelID,
   241         EWlanChannelID,
   215         
   242 
   216         /**
   243         /**
   217         * Gives whether it is allowed to roam inside one SSID or not.
   244         * Gives whether it is allowed to roam inside one SSID or not.
   218         * (TBool - default: determined through variation )
   245         * (TBool - default: determined through variation )
   219         */
   246         */
   220         EWlanAllowSSIDRoaming,
   247         EWlanAllowSSIDRoaming,
   221         
   248 
   222             
   249         /**
   223         // The following attributes before EWlanRangeMax are for internal use only
   250         * WEP key data.
       
   251         * Key data is in hex-format (0-9, A-F, length 10 or 26).
       
   252         * String (8-bit)
       
   253         */
       
   254         EWlanWepKey1InHex = 31000,
       
   255         EWlanWepKey2InHex,
       
   256         EWlanWepKey3InHex,
       
   257         EWlanWepKey4InHex,
       
   258 
       
   259         /**
       
   260         * WEP key data.
       
   261         * Key data is in ascii-format (length 5 or 13).
       
   262         * String (8-bit)
       
   263         */
       
   264         EWlanWepKey1InAscii,
       
   265         EWlanWepKey2InAscii,
       
   266         EWlanWepKey3InAscii,
       
   267         EWlanWepKey4InAscii,
       
   268 
       
   269         /**
       
   270         * Used WEP key.
       
   271         * TWepKeyIndex
       
   272         */
       
   273         EWlanWepKeyIndex,
       
   274 
       
   275         /**
       
   276         * Is unencrypted mode allowed in 802.1x.
       
   277         * TBool
       
   278         */
       
   279         EWlan802_1xAllowUnencrypted = 31050,
       
   280 
       
   281         /**
       
   282         * WPA pre-shared key usage.
       
   283         * TBool
       
   284         */
       
   285         EWlanEnableWpaPsk = 31100,
       
   286 
       
   287         /**
       
   288         * WPA pre-shared key.
       
   289         * String (8-bit)
       
   290         */
       
   291         EWlanWpaPreSharedKey,
       
   292 
       
   293         /**
       
   294         * WAPI pre-shared key data.
       
   295         * String (8-bit)
       
   296         */
       
   297         EWlanWapiPsk = 31150,
       
   298 
       
   299         /**
       
   300         * The format of the WAPI key (ascii, hex)
       
   301         * TWlanWapiKeyFormat
       
   302         */
       
   303         EWlanWapiPskFormat,
       
   304 
       
   305         // The following attributes before EWlanRangeMax are for internal use only.
   224         /**
   306         /**
   225         * Internal limiter
   307         * Internal limiter
   226         */
   308         */
   227         EWlanRangeInternal = 35000,
   309         EWlanRangeInternal = 35000,
   228             
   310 
   229         /**
   311         /**
   230         * Internal, used for the security settings.
   312         * Internal, used for the security settings.
   231         */
   313         */
   232         EWlanSecuritySettings,
   314         EWlanSecuritySettings,
   233         
   315 
   234         /**
   316         /**
   235         * Marks the end of WLAN attributes.
   317         * Marks the end of WLAN attributes.
   236         */
   318         */
   237         EWlanRangeMax = 39999
   319         EWlanRangeMax = 39999
   238         };
   320         };