ipcm_pub/connection_settings_api/inc/cmpluginwlandef.h
changeset 20 9c97ad6591ae
parent 0 5a93021fdf25
child 58 83ca720e2b9a
--- a/ipcm_pub/connection_settings_api/inc/cmpluginwlandef.h	Fri Apr 16 15:21:37 2010 +0300
+++ b/ipcm_pub/connection_settings_api/inc/cmpluginwlandef.h	Mon May 03 12:53:07 2010 +0300
@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
+* Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
@@ -11,7 +11,8 @@
 *
 * Contributors:
 *
-* Description:  ?description
+* Description:
+* WLAN specific enums.
 *
 */
 
@@ -25,15 +26,15 @@
 
 namespace CMManager
     {
-    /** enumerations for WLAN network modes */
+    /** Enumerations for WLAN network modes. */
     enum TWlanNetMode
         {
         EAdhoc       = 0,   ///< Ad-Hoc mode
         EInfra       = 1    ///< Infrastructure mode
         };
-        
-    /** enumerations for WLAN security modes 
-     ** It's possible to extend this enumeration */
+
+    /** Enumerations for WLAN security modes.
+     ** It's possible to extend this enumeration. */
     enum TWlanSecMode
         {
         EWlanSecModeOpen    = 1,    ///< Open security mode
@@ -44,7 +45,33 @@
         EWlanSecModeWAPI    = 32    ///< WAPI security mode
         };
 
-    /** Wlan specific connection method attributes */
+    /** Enumerations for WLAN authentication modes.
+     ** It's possible to extend this enumeration. */
+    enum TWlanAuthMode
+        {
+        EWlanAuthModeOpen   = 0,
+        EWlanAuthModeShared = 1
+        };
+
+    /** Enumerations for WAPI pre-shared key format (ascii, hex).
+     ** It's possible to extend this enumeration. */
+    enum TWlanWapiPskFormat
+        {
+        EWlanWapiPskFormatAscii = 0,
+        EWlanWapiPskFormatHex
+        };
+
+    /** Enumerations for the WEP key indexes.
+     ** It's possible to extend this enumeration. */
+    enum TWepKeyIndex
+        {
+        EWepKeyIndex1 = 0, // Key number 1
+        EWepKeyIndex2,     // Key number 2
+        EWepKeyIndex3,     // Key number 3
+        EWepKeyIndex4      // Key number 4
+        };
+
+    /** WLAN specific connection method attributes. */
     enum TConnectionMethodWlanSpecificAttributes
         {
         /**
@@ -56,27 +83,27 @@
         /**
         * IP net mask of interface.
         * ( String - default: None)
-        */        
+        */
         EWlanIpNetMask,
-            
+
         /**
-        * IP address of gateway
+        * IP address of gateway.
         * ( String - default: None)
         */
         EWlanIpGateway,
-            
+
         /**
         * Get IP addresses (for EPOC) from server?
         * ( TBool - default: None)
         */
         EWlanIpAddrFromServer,
-        
+
         /**
         * IP address of EPOC.
         * ( String - default: None)
         */
         EWlanIpAddr,
-        
+
         /**
         * Get DNS addresses from server?
         * ( TBool - default: None)
@@ -88,149 +115,204 @@
         * ( String - default: None)
         */
         EWlanIpNameServer1,
-            
+
         /**
         * IP Address of secondary name server.
         * ( String - default: None)
         */
         EWlanIpNameServer2,
-        
+
         /**
         * Get IP6 DNS addresses from server?
         * ( TBool - default: None)
         */
         EWlanIp6DNSAddrFromServer,
-        
+
         /**
         * IP6 Address of primary name server.
         * ( String - default: None)
         */
         EWlanIp6NameServer1,
-        
+
         /**
         * IP6 Address of secondary name server.
         * ( String - default: None)
         */
         EWlanIp6NameServer2,
-        
+
         /**
-        * IP address valid from this time, used to store 
+        * IP address valid from this time, used to store
         * dynamically assigned address lease info.
         * ( String - default: None)
         */
         EWlanIpAddrLeaseValidFrom,
-            
+
         /**
         * IP address valid for use until this time, used to store
         * dynamically assigned address lease info.
         * ( String - default: None)
         */
         EWlanIpAddrLeaseValidTo,
-            
+
         /**
-        * Name of the ECOM configuration daemon manager component. 
-        * This component interfaces with the server identified in 
-        * ISP_CONFIG_DAEMON_NAME. If specified, ISP_CONFIG_DAEMON_NAME 
-        * should also be specified. 
+        * Name of the ECOM configuration daemon manager component.
+        * This component interfaces with the server identified in
+        * ISP_CONFIG_DAEMON_NAME. If specified, ISP_CONFIG_DAEMON_NAME
+        * should also be specified.
         * ( String - default: None)
         */
         EWlanConfigDaemonManagerName,
-            
+
         /**
-        * Name of the configuration daemon server. 
-        * This server is used to provide further configuration for 
-        * a connection, e.g. dynamic IP address assignment. 
-        * If specified, ISP_CONFIG_DAEMON_MANAGER_NAME should also 
+        * Name of the configuration daemon server.
+        * This server is used to provide further configuration for
+        * a connection, e.g. dynamic IP address assignment.
+        * If specified, ISP_CONFIG_DAEMON_MANAGER_NAME should also
         * be specified.
         * ( String - default: None)
         */
         EWlanConfigDaemonName,
-            
+
         /**
         * Name of the WLAN Service Extension table.
         * ( String - default: None)
         */
         EWlanServiceExtensionTableName,
-            
+
         /**
         * The record ID of the linked WLAN Service Extension record in the
         * WLAN Service Extension table.
         * ( TUint32 - default: None)
         */
         EWlanServiceExtensionTableRecordId,
-        
+
         /**
         * Marks the beginning of WLAN specific attributes.
         */
         EWlanSpecificAttributes = 30000,
-            
+
         /**
         * The record ID to which IAP record these settings belong to.
         * ( TUint32 - default: None)
         */
         EWlanServiceId = 30100,
-            
+
         /**
         * The connection mode. This can be either Ad-hoc or infrastructure.
         * TWlanNetMode enum is to be used.
         * ( TUint32 - default: EInfra )
         */
         EWlanConnectionMode,
-            
+
         /**
         * The SSID of this WLAN connection.
         * ( String - default: None)
         */
         EWlanSSID,
-            
+
         /**
         * Used SSID.
         * ( String - default: None)
         */
         EWlanUsedSSID,
-            
+
         /**
         * The security mode of this WLAN connection. It is a TWlanSecMode enum.
         * ( TUint32 - default: EWlanSecModeOpen )
         */
         EWlanSecurityMode,
-            
+
         /**
-        * Authentication type: none, wep, wpa, wpapresharedkey
-        * ( TUint32 - default: None )
+        * Authentication mode: Defined in TWlanAuthMode.
+        * ( TUint32 - default: EWlanAuthModeOpen )
         */
         EWlanAuthenticationMode,
-            
+
         /**
         * Gives whether it should scan for the SSID.
         * (TBool - default: EFalse )
         */
         EWlanScanSSID,
-        
+
         /**
         * This is the channel ID in ad-hoc network mode
         * ( TUint32 - default: EAdhocAutomatic, if set to EAdhocUserDefined default = 7 )
         */
         EWlanChannelID,
-        
+
         /**
         * Gives whether it is allowed to roam inside one SSID or not.
         * (TBool - default: determined through variation )
         */
         EWlanAllowSSIDRoaming,
-        
-            
-        // The following attributes before EWlanRangeMax are for internal use only
+
+        /**
+        * WEP key data.
+        * Key data is in hex-format (0-9, A-F, length 10 or 26).
+        * String (8-bit)
+        */
+        EWlanWepKey1InHex = 31000,
+        EWlanWepKey2InHex,
+        EWlanWepKey3InHex,
+        EWlanWepKey4InHex,
+
+        /**
+        * WEP key data.
+        * Key data is in ascii-format (length 5 or 13).
+        * String (8-bit)
+        */
+        EWlanWepKey1InAscii,
+        EWlanWepKey2InAscii,
+        EWlanWepKey3InAscii,
+        EWlanWepKey4InAscii,
+
+        /**
+        * Used WEP key.
+        * TWepKeyIndex
+        */
+        EWlanWepKeyIndex,
+
+        /**
+        * Is unencrypted mode allowed in 802.1x.
+        * TBool
+        */
+        EWlan802_1xAllowUnencrypted = 31050,
+
+        /**
+        * WPA pre-shared key usage.
+        * TBool
+        */
+        EWlanEnableWpaPsk = 31100,
+
+        /**
+        * WPA pre-shared key.
+        * String (8-bit)
+        */
+        EWlanWpaPreSharedKey,
+
+        /**
+        * WAPI pre-shared key data.
+        * String (8-bit)
+        */
+        EWlanWapiPsk = 31150,
+
+        /**
+        * The format of the WAPI key (ascii, hex)
+        * TWlanWapiKeyFormat
+        */
+        EWlanWapiPskFormat,
+
+        // The following attributes before EWlanRangeMax are for internal use only.
         /**
         * Internal limiter
         */
         EWlanRangeInternal = 35000,
-            
+
         /**
         * Internal, used for the security settings.
         */
         EWlanSecuritySettings,
-        
+
         /**
         * Marks the end of WLAN attributes.
         */