NetworkPkg/WifiConnectionManagerDxe/WifiConnectionMgrConfigNVDataStruct.h

   1 /** @file
   2   Define IFR NVData structures used by the WiFi Connection Manager.
   3
   4   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   5
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _WIFI_NVDATASTRUC_H_
  11 #define _WIFI_NVDATASTRUC_H_
  12
  13 #include <Guid/WifiConnectionManagerConfigHii.h>
  14 #include "WifiConnectionMgrConfigHii.h"
  15
  16 #define MANAGER_VARSTORE_ID           0x0802
  17
  18 #define WIFI_STR_MAX_SIZE             224
  19 #define WIFI_FILENAME_STR_MAX_SIZE    224
  20 #define WIFI_MGR_MAX_MAC_STRING_LEN   96
  21
  22 #define SSID_MIN_LEN                  1
  23 #define SSID_MAX_LEN                  32
  24 #define SSID_STORAGE_SIZE             33
  25
  26 #define PASSWORD_MIN_LEN              8
  27 #define PASSWORD_MAX_LEN              63
  28 #define PASSWORD_STORAGE_SIZE         64
  29
  30 #define EAP_IDENTITY_LEN              63
  31 #define EAP_IDENTITY_SIZE             64
  32
  33 #define FORMID_NONE_FORM              0
  34 #define FORMID_MAC_SELECTION          1
  35 #define FORMID_WIFI_MAINPAGE          2
  36 #define FORMID_NETWORK_LIST           3
  37 #define FORMID_CONNECT_NETWORK        4
  38 #define FORMID_ENROLL_CERT            5
  39 #define FORMID_CA_LIST                6
  40 #define FORMID_ENROLL_PRIVATE_KEY     7
  41 #define FORMID_PRIVATE_KEY_LIST       8
  42 #define FORMID_WIFI_SETTINGS          9
  43 #define FORMID_HIDDEN_NETWORK_LIST    10
  44
  45 //
  46 // Mac List Form Key
  47 //
  48 #define KEY_MAC_LIST                              0x100
  49
  50 //
  51 // Main Form Key
  52 //
  53 #define KEY_REFRESH_TITLE_CONNECTION_STATUS       0x101
  54
  55 //
  56 // Network List Form Key
  57 //
  58 #define KEY_NETWORK_LIST                          0x102
  59 #define KEY_REFRESH_NETWORK_LIST                  0x103
  60 #define KEY_WIFI_SETTINGS                         0x104
  61
  62 //
  63 // Connect Network Form Key
  64 //
  65 #define KEY_PASSWORD_CONNECT_NETWORK              0x201
  66 #define KEY_CONNECT_ACTION                        0x202
  67 #define KEY_REFRESH_CONNECT_CONFIGURATION         0x203
  68 #define KEY_EAP_AUTH_METHOD_CONNECT_NETWORK       0x204
  69 #define KEY_EAP_SEAUTH_METHOD_CONNECT_NETWORK     0x205
  70 #define KEY_ENROLL_CA_CERT_CONNECT_NETWORK        0x206
  71 #define KEY_ENROLL_CLIENT_CERT_CONNECT_NETWORK    0x207
  72 #define KEY_ENROLL_PRIVATE_KEY_CONNECT_NETWORK    0x208
  73 #define KEY_EAP_IDENTITY_CONNECT_NETWORK          0x209
  74 #define KEY_EAP_PASSWORD_CONNECT_NETWORK          0x210
  75
  76 //
  77 //Cert Form And Private Key Form
  78 //
  79 #define KEY_EAP_ENROLL_CERT_FROM_FILE             0x301
  80 #define KEY_EAP_ENROLL_PRIVATE_KEY_FROM_FILE      0x302
  81 #define KEY_SAVE_CERT_TO_MEM                      0x303
  82 #define KEY_NO_SAVE_CERT_TO_MEM                   0x304
  83 #define KEY_SAVE_PRIVATE_KEY_TO_MEM               0x305
  84 #define KEY_NO_SAVE_PRIVATE_KEY_TO_MEM            0x306
  85 #define KEY_PRIVATE_KEY_PASSWORD                  0x307
  86 #define KEY_ENROLLED_CERT_NAME                    0x308
  87 #define KEY_ENROLLED_PRIVATE_KEY_NAME             0x309
  88
  89 //
  90 // Hidden Network Configuration Form
  91 //
  92 #define KEY_HIDDEN_NETWORK                        0x401
  93 #define KEY_ADD_HIDDEN_NETWORK                    0x402
  94 #define KEY_REMOVE_HIDDEN_NETWORK                 0x403
  95
  96 //
  97 // Dynamic Lists
  98 //
  99 #define MAC_LIST_COUNT_MAX                        255
 100 #define LABEL_MAC_ENTRY                           0x1000
 101 #define KEY_MAC_ENTRY_BASE                        0x1100
 102
 103 #define NETWORK_LIST_COUNT_MAX                    4095
 104 #define LABEL_NETWORK_LIST_ENTRY                  0x2000
 105 #define KEY_AVAILABLE_NETWORK_ENTRY_BASE          0x3000
 106
 107 #define HIDDEN_NETWORK_LIST_COUNT_MAX             255
 108 #define LABEL_HIDDEN_NETWORK_ENTRY                0x4000
 109 #define KEY_HIDDEN_NETWORK_ENTRY_BASE             0x4100
 110
 111 #define LABEL_END                                 0xffff
 112
 113 //
 114 // Network Security Type
 115 //
 116 #define SECURITY_TYPE_NONE                        0
 117 #define SECURITY_TYPE_WPA_ENTERPRISE              1
 118 #define SECURITY_TYPE_WPA2_ENTERPRISE             2
 119 #define SECURITY_TYPE_WPA_PERSONAL                3
 120 #define SECURITY_TYPE_WPA2_PERSONAL               4
 121 #define SECURITY_TYPE_WEP                         5
 122 #define SECURITY_TYPE_UNKNOWN                     6
 123 #define SECURITY_TYPE_MAX                         7
 124
 125 #define EAP_AUTH_METHOD_TTLS                      0
 126 #define EAP_AUTH_METHOD_PEAP                      1
 127 #define EAP_AUTH_METHOD_TLS                       2
 128 #define EAP_AUTH_METHOD_MAX                       3
 129
 130 #define EAP_SEAUTH_METHOD_MSCHAPV2                0
 131 #define EAP_SEAUTH_METHOD_MAX                     1
 132
 133 #define HIDDEN_NETWORK_LIST_VAR_OFFSET ((UINT16) OFFSET_OF (WIFI_MANAGER_IFR_NVDATA, HiddenNetworkList))
 134
 135 #pragma pack(1)
 136 typedef struct _WIFI_MANAGER_IFR_NVDATA {
 137
 138   UINT32      ProfileCount;
 139   CHAR16      SSId[SSID_STORAGE_SIZE];
 140   CHAR16      Password[PASSWORD_STORAGE_SIZE];
 141   CHAR16      PrivateKeyPassword[PASSWORD_STORAGE_SIZE];
 142   CHAR16      EapIdentity[EAP_IDENTITY_SIZE];
 143   CHAR16      EapPassword[PASSWORD_STORAGE_SIZE];
 144   UINT8       SecurityType;
 145   UINT8       EapAuthMethod;
 146   UINT8       EapSecondAuthMethod;
 147   UINT8       HiddenNetworkList[HIDDEN_NETWORK_LIST_COUNT_MAX];
 148
 149 } WIFI_MANAGER_IFR_NVDATA;
 150 #pragma pack()
 151
 152 #endif