2 Helper functions for configuring or getting the parameters relating to iSCSI.
4 Copyright (c) 2004 - 2009, Intel Corporation.<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "IScsiImpl.h"
17 EFI_GUID mVendorGuid
= ISCSI_CONFIG_GUID
;
18 CHAR16 mVendorStorageName
[] = L
"ISCSI_CONFIG_IFR_NVDATA";
19 BOOLEAN mIScsiDeviceListUpdated
= FALSE
;
20 UINTN mNumberOfIScsiDevices
= 0;
21 ISCSI_FORM_CALLBACK_INFO
*mCallbackInfo
= NULL
;
23 LIST_ENTRY mIScsiConfigFormList
= {
24 &mIScsiConfigFormList
,
28 HII_VENDOR_DEVICE_PATH mIScsiHiiVendorDevicePath
= {
34 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
35 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
39 // {49D7B73E-143D-4716-977B-C45F1CB038CC}
41 { 0x49d7b73e, 0x143d, 0x4716, { 0x97, 0x7b, 0xc4, 0x5f, 0x1c, 0xb0, 0x38, 0xcc } }
45 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
47 (UINT8
) (END_DEVICE_PATH_LENGTH
),
48 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
54 Convert the IPv4 address into a dotted string.
56 @param[in] Ip The IPv4 address.
57 @param[out] Str The dotted IP string.
61 IN EFI_IPv4_ADDRESS
*Ip
,
65 UnicodeSPrint ( Str
, 2 * IP4_STR_MAX_SIZE
, L
"%d.%d.%d.%d", Ip
->Addr
[0], Ip
->Addr
[1], Ip
->Addr
[2], Ip
->Addr
[3]);
69 Update the list of iSCSI devices the iSCSI driver is controlling.
71 @retval EFI_SUCCESS The callback successfully handled the action.
72 @retval Others Other errors as indicated.
75 IScsiUpdateDeviceList (
80 ISCSI_DEVICE_LIST
*DeviceList
;
86 UINTN LastDeviceIndex
;
87 EFI_MAC_ADDRESS MacAddress
;
90 ISCSI_MAC_INFO
*CurMacInfo
;
91 ISCSI_MAC_INFO TempMacInfo
;
96 // Dump all the handles the Managed Network Service Binding Protocol is installed on.
98 Status
= gBS
->LocateHandleBuffer (
100 &gEfiManagedNetworkServiceBindingProtocolGuid
,
105 if (EFI_ERROR (Status
)) {
110 Status
= gRT
->GetVariable (
117 if (Status
== EFI_BUFFER_TOO_SMALL
) {
118 DeviceList
= (ISCSI_DEVICE_LIST
*) AllocatePool (DataSize
);
130 for (HandleIndex
= 0; HandleIndex
< NumHandles
; HandleIndex
++) {
131 Status
= NetLibGetMacAddress (Handles
[HandleIndex
], &MacAddress
, &HwAddressSize
);
132 ASSERT (Status
== EFI_SUCCESS
);
133 VlanId
= NetLibGetVlanId (Handles
[HandleIndex
]);
135 for (Index
= LastDeviceIndex
; Index
< DeviceList
->NumDevice
; Index
++) {
136 CurMacInfo
= &DeviceList
->MacInfo
[Index
];
137 if ((CurMacInfo
->Len
== HwAddressSize
) &&
138 (CurMacInfo
->VlanId
== VlanId
) &&
139 (NET_MAC_EQUAL (&CurMacInfo
->Mac
, MacAddress
.Addr
, HwAddressSize
))
142 // The previous configured NIC is still here.
144 if (Index
!= LastDeviceIndex
) {
146 // Swap the current MAC address entry with the one indexed by
149 CopyMem (&TempMacInfo
, CurMacInfo
, sizeof (ISCSI_MAC_INFO
));
150 CopyMem (CurMacInfo
, &DeviceList
->MacInfo
[LastDeviceIndex
], sizeof (ISCSI_MAC_INFO
));
151 CopyMem (&DeviceList
->MacInfo
[LastDeviceIndex
], &TempMacInfo
, sizeof (ISCSI_MAC_INFO
));
158 if (LastDeviceIndex
== DeviceList
->NumDevice
) {
163 for (Index
= LastDeviceIndex
; Index
< DeviceList
->NumDevice
; Index
++) {
165 // delete the variables
167 CurMacInfo
= &DeviceList
->MacInfo
[Index
];
168 IScsiMacAddrToStr (&CurMacInfo
->Mac
, CurMacInfo
->Len
, CurMacInfo
->VlanId
, MacString
);
169 gRT
->SetVariable (MacString
, &gEfiIScsiInitiatorNameProtocolGuid
, 0, 0, NULL
);
170 gRT
->SetVariable (MacString
, &mIScsiCHAPAuthInfoGuid
, 0, 0, NULL
);
173 FreePool (DeviceList
);
174 } else if (Status
!= EFI_NOT_FOUND
) {
179 // Construct the new iSCSI device list.
181 DeviceListSize
= sizeof (ISCSI_DEVICE_LIST
) + (NumHandles
- 1) * sizeof (ISCSI_MAC_INFO
);
182 DeviceList
= (ISCSI_DEVICE_LIST
*) AllocatePool (DeviceListSize
);
183 DeviceList
->NumDevice
= (UINT8
) NumHandles
;
185 for (Index
= 0; Index
< NumHandles
; Index
++) {
186 NetLibGetMacAddress (Handles
[Index
], &MacAddress
, &HwAddressSize
);
188 CurMacInfo
= &DeviceList
->MacInfo
[Index
];
189 CopyMem (&CurMacInfo
->Mac
, MacAddress
.Addr
, HwAddressSize
);
190 CurMacInfo
->Len
= (UINT8
) HwAddressSize
;
191 CurMacInfo
->VlanId
= NetLibGetVlanId (Handles
[Index
]);
197 ISCSI_CONFIG_VAR_ATTR
,
202 FreePool (DeviceList
);
209 Get the iSCSI configuration form entry by the index of the goto opcode actived.
211 @param[in] Index The 0-based index of the goto opcode actived.
213 @return The iSCSI configuration form entry found.
215 ISCSI_CONFIG_FORM_ENTRY
*
216 IScsiGetConfigFormEntryByIndex (
222 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
225 ConfigFormEntry
= NULL
;
227 NET_LIST_FOR_EACH (Entry
, &mIScsiConfigFormList
) {
228 if (CurrentIndex
== Index
) {
229 ConfigFormEntry
= NET_LIST_USER_STRUCT (Entry
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
236 return ConfigFormEntry
;
240 Convert the iSCSI configuration data into the IFR data.
242 @param[in] ConfigFormEntry The iSCSI configuration form entry.
243 @param[out] IfrNvData The IFR nv data.
246 IScsiConvertDeviceConfigDataToIfrNvData (
247 IN ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
,
248 OUT ISCSI_CONFIG_IFR_NVDATA
*IfrNvData
251 ISCSI_SESSION_CONFIG_NVDATA
*SessionConfigData
;
252 ISCSI_CHAP_AUTH_CONFIG_NVDATA
*AuthConfigData
;
255 // Normal session configuration parameters.
257 SessionConfigData
= &ConfigFormEntry
->SessionConfigData
;
258 IfrNvData
->Enabled
= SessionConfigData
->Enabled
;
260 IfrNvData
->InitiatorInfoFromDhcp
= SessionConfigData
->InitiatorInfoFromDhcp
;
261 IfrNvData
->TargetInfoFromDhcp
= SessionConfigData
->TargetInfoFromDhcp
;
262 IfrNvData
->TargetPort
= SessionConfigData
->TargetPort
;
264 IScsiIpToStr (&SessionConfigData
->LocalIp
, IfrNvData
->LocalIp
);
265 IScsiIpToStr (&SessionConfigData
->SubnetMask
, IfrNvData
->SubnetMask
);
266 IScsiIpToStr (&SessionConfigData
->Gateway
, IfrNvData
->Gateway
);
267 IScsiIpToStr (&SessionConfigData
->TargetIp
, IfrNvData
->TargetIp
);
269 IScsiAsciiStrToUnicodeStr (SessionConfigData
->TargetName
, IfrNvData
->TargetName
);
271 IScsiLunToUnicodeStr (SessionConfigData
->BootLun
, IfrNvData
->BootLun
);
274 // CHAP authentication parameters.
276 AuthConfigData
= &ConfigFormEntry
->AuthConfigData
;
278 IfrNvData
->CHAPType
= AuthConfigData
->CHAPType
;
280 IScsiAsciiStrToUnicodeStr (AuthConfigData
->CHAPName
, IfrNvData
->CHAPName
);
281 IScsiAsciiStrToUnicodeStr (AuthConfigData
->CHAPSecret
, IfrNvData
->CHAPSecret
);
282 IScsiAsciiStrToUnicodeStr (AuthConfigData
->ReverseCHAPName
, IfrNvData
->ReverseCHAPName
);
283 IScsiAsciiStrToUnicodeStr (AuthConfigData
->ReverseCHAPSecret
, IfrNvData
->ReverseCHAPSecret
);
287 This function allows the caller to request the current
288 configuration for one or more named elements. The resulting
289 string is in <ConfigAltResp> format. Any and all alternative
290 configuration strings shall also be appended to the end of the
291 current configuration string. If they are, they must appear
292 after the current configuration. They must contain the same
293 routing (GUID, NAME, PATH) as the current configuration string.
294 They must have an additional description indicating the type of
295 alternative configuration the string represents,
296 "ALTCFG=<StringToken>". That <StringToken> (when
297 converted from Hex UNICODE to binary) is a reference to a
298 string in the associated string pack.
300 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
301 @param[in] Request A null-terminated Unicode string in
302 <ConfigRequest> format. Note that this
303 includes the routing information as well as
304 the configurable name / value pairs. It is
305 invalid for this string to be in
306 <MultiConfigRequest> format.
307 @param[out] Progress On return, points to a character in the
308 Request string. Points to the string's null
309 terminator if request was successful. Points
310 to the most recent "&" before the first
311 failing name / value pair (or the beginning
312 of the string if the failure is in the first
313 name / value pair) if the request was not
315 @param[out] Results A null-terminated Unicode string in
316 <ConfigAltResp> format which has all values
317 filled in for the names in the Request string.
318 String to be allocated by the called function.
320 @retval EFI_SUCCESS The Results string is filled with the
321 values corresponding to all requested
323 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
324 parts of the results that must be
325 stored awaiting possible future
327 @retval EFI_INVALID_PARAMETER For example, passing in a NULL
328 for the Request parameter
329 would result in this type of
330 error. In this case, the
331 Progress parameter would be
333 @retval EFI_NOT_FOUND Routing data doesn't match any
334 known driver. Progress set to the
335 first character in the routing header.
336 Note: There is no requirement that the
337 driver validate the routing data. It
338 must skip the <ConfigHdr> in order to
340 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
341 to most recent & before the
342 error or the beginning of the
344 @retval EFI_INVALID_PARAMETER Unknown name. Progress points
345 to the & before the name in
346 question.Currently not implemented.
350 IScsiFormExtractConfig (
351 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
352 IN CONST EFI_STRING Request
,
353 OUT EFI_STRING
*Progress
,
354 OUT EFI_STRING
*Results
358 CHAR8 InitiatorName
[ISCSI_NAME_IFR_MAX_SIZE
];
360 ISCSI_CONFIG_IFR_NVDATA
*IfrNvData
;
361 ISCSI_FORM_CALLBACK_INFO
*Private
;
362 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
364 if (Request
== NULL
|| Progress
== NULL
|| Results
== NULL
) {
365 return EFI_INVALID_PARAMETER
;
369 if (!mIScsiDeviceListUpdated
) {
371 // Update the device list.
373 IScsiUpdateDeviceList ();
374 mIScsiDeviceListUpdated
= TRUE
;
377 Private
= ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This
);
378 IfrNvData
= AllocateZeroPool (sizeof (ISCSI_CONFIG_IFR_NVDATA
));
379 ASSERT (IfrNvData
!= NULL
);
380 if (Private
->Current
!= NULL
) {
381 IScsiConvertDeviceConfigDataToIfrNvData (Private
->Current
, IfrNvData
);
384 BufferSize
= ISCSI_NAME_IFR_MAX_SIZE
;
385 Status
= gIScsiInitiatorName
.Get (&gIScsiInitiatorName
, &BufferSize
, InitiatorName
);
386 if (EFI_ERROR (Status
)) {
387 IfrNvData
->InitiatorName
[0] = L
'\0';
389 IScsiAsciiStrToUnicodeStr (InitiatorName
, IfrNvData
->InitiatorName
);
393 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
395 HiiConfigRouting
= Private
->ConfigRouting
;
396 BufferSize
= sizeof (ISCSI_CONFIG_IFR_NVDATA
);
397 Status
= HiiConfigRouting
->BlockToConfig (
405 FreePool (IfrNvData
);
410 This function applies changes in a driver's configuration.
411 Input is a Configuration, which has the routing data for this
412 driver followed by name / value configuration pairs. The driver
413 must apply those pairs to its configurable storage. If the
414 driver's configuration is stored in a linear block of data
415 and the driver's name / value pairs are in <BlockConfig>
416 format, it may use the ConfigToBlock helper function (above) to
417 simplify the job. Currently not implemented.
419 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
420 @param[in] Configuration A null-terminated Unicode string in
421 <ConfigString> format.
422 @param[out] Progress A pointer to a string filled in with the
423 offset of the most recent '&' before the
424 first failing name / value pair (or the
425 beginn ing of the string if the failure
426 is in the first name / value pair) or
427 the terminating NULL if all was
430 @retval EFI_SUCCESS The results have been distributed or are
431 awaiting distribution.
432 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
433 parts of the results that must be
434 stored awaiting possible future
436 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
437 Results parameter would result
438 in this type of error.
439 @retval EFI_NOT_FOUND Target for the specified routing data
444 IScsiFormRouteConfig (
445 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
446 IN CONST EFI_STRING Configuration
,
447 OUT EFI_STRING
*Progress
450 if (Configuration
== NULL
|| Progress
== NULL
) {
451 return EFI_INVALID_PARAMETER
;
455 // Check routing data in <ConfigHdr>.
456 // Note: if only one Storage is used, then this checking could be skipped.
458 if (!HiiIsConfigHdrMatch (Configuration
, &mVendorGuid
, mVendorStorageName
)) {
459 *Progress
= Configuration
;
460 return EFI_NOT_FOUND
;
463 *Progress
= Configuration
+ StrLen (Configuration
);
468 This function is called to provide results data to the driver.
469 This data consists of a unique key that is used to identify
470 which data is either being passed back or being asked for.
472 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
473 @param[in] Action Specifies the type of action taken by the browser.
474 @param[in] QuestionId A unique value which is sent to the original
475 exporting driver so that it can identify the type
476 of data to expect. The format of the data tends to
477 vary based on the opcode that enerated the callback.
478 @param[in] Type The type of value for the question.
479 @param[in] Value A pointer to the data being sent to the original
481 @param[out] ActionRequest On return, points to the action requested by the
484 @retval EFI_SUCCESS The callback successfully handled the action.
485 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
486 variable and its data.
487 @retval EFI_DEVICE_ERROR The variable could not be saved.
488 @retval EFI_UNSUPPORTED The specified Action is not supported by the
489 callback.Currently not implemented.
490 @retval EFI_INVALID_PARAMETERS Passing in wrong parameter.
491 @retval Others Other errors as indicated.
496 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
497 IN EFI_BROWSER_ACTION Action
,
498 IN EFI_QUESTION_ID QuestionId
,
500 IN EFI_IFR_TYPE_VALUE
*Value
,
501 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
504 ISCSI_FORM_CALLBACK_INFO
*Private
;
506 CHAR8 IScsiName
[ISCSI_NAME_IFR_MAX_SIZE
];
507 CHAR16 PortString
[128];
508 CHAR8 Ip4String
[IP4_STR_MAX_SIZE
];
509 CHAR8 LunString
[ISCSI_LUN_STR_MAX_LEN
];
511 EFI_STRING_ID DeviceFormTitleToken
;
512 ISCSI_CONFIG_IFR_NVDATA
*IfrNvData
;
513 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
514 EFI_IP_ADDRESS HostIp
;
515 EFI_IP_ADDRESS SubnetMask
;
516 EFI_IP_ADDRESS Gateway
;
520 Private
= ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This
);
523 // Retrive uncommitted data from Browser
525 IfrNvData
= AllocateZeroPool (sizeof (ISCSI_CONFIG_IFR_NVDATA
));
526 ASSERT (IfrNvData
!= NULL
);
527 if (!HiiGetBrowserData (&mVendorGuid
, mVendorStorageName
, sizeof (ISCSI_CONFIG_IFR_NVDATA
), (UINT8
*) IfrNvData
)) {
528 FreePool (IfrNvData
);
529 return EFI_NOT_FOUND
;
532 Status
= EFI_SUCCESS
;
534 switch (QuestionId
) {
535 case KEY_INITIATOR_NAME
:
536 IScsiUnicodeStrToAsciiStr (IfrNvData
->InitiatorName
, IScsiName
);
537 BufferSize
= AsciiStrLen (IScsiName
) + 1;
539 Status
= gIScsiInitiatorName
.Set (&gIScsiInitiatorName
, &BufferSize
, IScsiName
);
540 if (EFI_ERROR (Status
)) {
541 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid iSCSI Name!", NULL
);
547 IScsiUnicodeStrToAsciiStr (IfrNvData
->LocalIp
, Ip4String
);
548 Status
= IScsiAsciiStrToIp (Ip4String
, &HostIp
.v4
);
549 if (EFI_ERROR (Status
) || !NetIp4IsUnicast (NTOHL (HostIp
.Addr
[0]), 0)) {
550 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid IP address!", NULL
);
551 Status
= EFI_INVALID_PARAMETER
;
553 CopyMem (&Private
->Current
->SessionConfigData
.LocalIp
, &HostIp
.v4
, sizeof (HostIp
.v4
));
558 case KEY_SUBNET_MASK
:
559 IScsiUnicodeStrToAsciiStr (IfrNvData
->SubnetMask
, Ip4String
);
560 Status
= IScsiAsciiStrToIp (Ip4String
, &SubnetMask
.v4
);
561 if (EFI_ERROR (Status
) || ((SubnetMask
.Addr
[0] != 0) && (IScsiGetSubnetMaskPrefixLength (&SubnetMask
.v4
) == 0))) {
562 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid Subnet Mask!", NULL
);
563 Status
= EFI_INVALID_PARAMETER
;
565 CopyMem (&Private
->Current
->SessionConfigData
.SubnetMask
, &SubnetMask
.v4
, sizeof (SubnetMask
.v4
));
571 IScsiUnicodeStrToAsciiStr (IfrNvData
->Gateway
, Ip4String
);
572 Status
= IScsiAsciiStrToIp (Ip4String
, &Gateway
.v4
);
573 if (EFI_ERROR (Status
) || ((Gateway
.Addr
[0] != 0) && !NetIp4IsUnicast (NTOHL (Gateway
.Addr
[0]), 0))) {
574 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid Gateway!", NULL
);
575 Status
= EFI_INVALID_PARAMETER
;
577 CopyMem (&Private
->Current
->SessionConfigData
.Gateway
, &Gateway
.v4
, sizeof (Gateway
.v4
));
583 IScsiUnicodeStrToAsciiStr (IfrNvData
->TargetIp
, Ip4String
);
584 Status
= IScsiAsciiStrToIp (Ip4String
, &HostIp
.v4
);
585 if (EFI_ERROR (Status
) || !NetIp4IsUnicast (NTOHL (HostIp
.Addr
[0]), 0)) {
586 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid IP address!", NULL
);
587 Status
= EFI_INVALID_PARAMETER
;
589 CopyMem (&Private
->Current
->SessionConfigData
.TargetIp
, &HostIp
.v4
, sizeof (HostIp
.v4
));
594 case KEY_TARGET_NAME
:
595 IScsiUnicodeStrToAsciiStr (IfrNvData
->TargetName
, IScsiName
);
596 Status
= IScsiNormalizeName (IScsiName
, AsciiStrLen (IScsiName
));
597 if (EFI_ERROR (Status
)) {
598 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid iSCSI Name!", NULL
);
600 AsciiStrCpy (Private
->Current
->SessionConfigData
.TargetName
, IScsiName
);
605 case KEY_DHCP_ENABLE
:
606 if (IfrNvData
->InitiatorInfoFromDhcp
== 0) {
607 IfrNvData
->TargetInfoFromDhcp
= 0;
613 IScsiUnicodeStrToAsciiStr (IfrNvData
->BootLun
, LunString
);
614 Status
= IScsiAsciiStrToLun (LunString
, (UINT8
*) &Lun
);
615 if (EFI_ERROR (Status
)) {
616 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid LUN string!", NULL
);
618 CopyMem (Private
->Current
->SessionConfigData
.BootLun
, &Lun
, sizeof (Lun
));
624 IScsiUnicodeStrToAsciiStr (IfrNvData
->CHAPName
, Private
->Current
->AuthConfigData
.CHAPName
);
627 case KEY_CHAP_SECRET
:
628 IScsiUnicodeStrToAsciiStr (IfrNvData
->CHAPSecret
, Private
->Current
->AuthConfigData
.CHAPSecret
);
631 case KEY_REVERSE_CHAP_NAME
:
632 IScsiUnicodeStrToAsciiStr (IfrNvData
->ReverseCHAPName
, Private
->Current
->AuthConfigData
.ReverseCHAPName
);
635 case KEY_REVERSE_CHAP_SECRET
:
636 IScsiUnicodeStrToAsciiStr (IfrNvData
->ReverseCHAPSecret
, Private
->Current
->AuthConfigData
.ReverseCHAPSecret
);
639 case KEY_SAVE_CHANGES
:
641 // First, update those fields which don't have INTERACTIVE set.
643 Private
->Current
->SessionConfigData
.Enabled
= IfrNvData
->Enabled
;
644 Private
->Current
->SessionConfigData
.InitiatorInfoFromDhcp
= IfrNvData
->InitiatorInfoFromDhcp
;
645 Private
->Current
->SessionConfigData
.TargetPort
= IfrNvData
->TargetPort
;
646 if (Private
->Current
->SessionConfigData
.TargetPort
== 0) {
647 Private
->Current
->SessionConfigData
.TargetPort
= ISCSI_WELL_KNOWN_PORT
;
650 Private
->Current
->SessionConfigData
.TargetInfoFromDhcp
= IfrNvData
->TargetInfoFromDhcp
;
651 Private
->Current
->AuthConfigData
.CHAPType
= IfrNvData
->CHAPType
;
654 // Only do full parameter validation if iSCSI is enabled on this device.
656 if (Private
->Current
->SessionConfigData
.Enabled
) {
658 // Validate the address configuration of the Initiator if DHCP isn't
661 if (!Private
->Current
->SessionConfigData
.InitiatorInfoFromDhcp
) {
662 CopyMem (&HostIp
.v4
, &Private
->Current
->SessionConfigData
.LocalIp
, sizeof (HostIp
.v4
));
663 CopyMem (&SubnetMask
.v4
, &Private
->Current
->SessionConfigData
.SubnetMask
, sizeof (SubnetMask
.v4
));
664 CopyMem (&Gateway
.v4
, &Private
->Current
->SessionConfigData
.Gateway
, sizeof (Gateway
.v4
));
666 if ((Gateway
.Addr
[0] != 0)) {
667 if (SubnetMask
.Addr
[0] == 0) {
668 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Gateway address is set but subnet mask is zero.", NULL
);
669 Status
= EFI_INVALID_PARAMETER
;
671 } else if (!IP4_NET_EQUAL (HostIp
.Addr
[0], Gateway
.Addr
[0], SubnetMask
.Addr
[0])) {
672 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Local IP and Gateway are not in the same subnet.", NULL
);
673 Status
= EFI_INVALID_PARAMETER
;
679 // Validate target configuration if DHCP isn't deployed.
681 if (!Private
->Current
->SessionConfigData
.TargetInfoFromDhcp
) {
682 CopyMem (&HostIp
.v4
, &Private
->Current
->SessionConfigData
.TargetIp
, sizeof (HostIp
.v4
));
683 if (!NetIp4IsUnicast (NTOHL (HostIp
.Addr
[0]), 0)) {
684 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Target IP is invalid!", NULL
);
685 Status
= EFI_INVALID_PARAMETER
;
690 if (IfrNvData
->CHAPType
!= ISCSI_CHAP_NONE
) {
691 if ((IfrNvData
->CHAPName
[0] == '\0') || (IfrNvData
->CHAPSecret
[0] == '\0')) {
692 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"CHAP Name or CHAP Secret is invalid!", NULL
);
693 Status
= EFI_INVALID_PARAMETER
;
697 if ((IfrNvData
->CHAPType
== ISCSI_CHAP_MUTUAL
) &&
698 ((IfrNvData
->ReverseCHAPName
[0] == '\0') || (IfrNvData
->ReverseCHAPSecret
[0] == '\0'))
700 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Reverse CHAP Name or Reverse CHAP Secret is invalid!", NULL
);
701 Status
= EFI_INVALID_PARAMETER
;
707 BufferSize
= sizeof (Private
->Current
->SessionConfigData
);
709 Private
->Current
->MacString
,
710 &gEfiIScsiInitiatorNameProtocolGuid
,
711 ISCSI_CONFIG_VAR_ATTR
,
713 &Private
->Current
->SessionConfigData
716 BufferSize
= sizeof (Private
->Current
->AuthConfigData
);
718 Private
->Current
->MacString
,
719 &mIScsiCHAPAuthInfoGuid
,
720 ISCSI_CONFIG_VAR_ATTR
,
722 &Private
->Current
->AuthConfigData
724 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
728 if ((QuestionId
>= KEY_DEVICE_ENTRY_BASE
) && (QuestionId
< (mNumberOfIScsiDevices
+ KEY_DEVICE_ENTRY_BASE
))) {
730 // In case goto the device configuration form, update the device form title.
732 ConfigFormEntry
= IScsiGetConfigFormEntryByIndex ((UINT32
) (QuestionId
- KEY_DEVICE_ENTRY_BASE
));
733 ASSERT (ConfigFormEntry
!= NULL
);
735 UnicodeSPrint (PortString
, (UINTN
) 128, L
"Port %s", ConfigFormEntry
->MacString
);
736 DeviceFormTitleToken
= (EFI_STRING_ID
) STR_ISCSI_DEVICE_FORM_TITLE
;
737 HiiSetString (Private
->RegisteredHandle
, DeviceFormTitleToken
, PortString
, NULL
);
739 IScsiConvertDeviceConfigDataToIfrNvData (ConfigFormEntry
, IfrNvData
);
741 Private
->Current
= ConfigFormEntry
;
747 if (!EFI_ERROR (Status
)) {
749 // Pass changed uncommitted data back to Form Browser
751 HiiSetBrowserData (&mVendorGuid
, mVendorStorageName
, sizeof (ISCSI_CONFIG_IFR_NVDATA
), (UINT8
*) IfrNvData
, NULL
);
754 FreePool (IfrNvData
);
759 Updates the iSCSI configuration form to add/delete an entry for the iSCSI
760 device specified by the Controller.
762 @param[in] DriverBindingHandle The driverbinding handle.
763 @param[in] Controller The controller handle of the iSCSI device.
764 @param[in] AddForm Whether to add or delete a form entry.
766 @retval EFI_SUCCESS The iSCSI configuration form is updated.
767 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
768 @retval Others Other errors as indicated.
771 IScsiConfigUpdateForm (
772 IN EFI_HANDLE DriverBindingHandle
,
773 IN EFI_HANDLE Controller
,
778 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
779 BOOLEAN EntryExisted
;
781 EFI_MAC_ADDRESS MacAddress
;
784 CHAR16 PortString
[128];
787 VOID
*StartOpCodeHandle
;
788 VOID
*EndOpCodeHandle
;
789 EFI_IFR_GUID_LABEL
*StartLabel
;
790 EFI_IFR_GUID_LABEL
*EndLabel
;
792 ConfigFormEntry
= NULL
;
793 EntryExisted
= FALSE
;
795 NET_LIST_FOR_EACH (Entry
, &mIScsiConfigFormList
) {
796 ConfigFormEntry
= NET_LIST_USER_STRUCT (Entry
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
798 if (ConfigFormEntry
->Controller
== Controller
) {
811 ConfigFormEntry
= (ISCSI_CONFIG_FORM_ENTRY
*) AllocateZeroPool (sizeof (ISCSI_CONFIG_FORM_ENTRY
));
812 if (ConfigFormEntry
== NULL
) {
813 return EFI_OUT_OF_RESOURCES
;
816 InitializeListHead (&ConfigFormEntry
->Link
);
817 ConfigFormEntry
->Controller
= Controller
;
820 // Get the MAC address and convert it into the formatted string.
822 Status
= NetLibGetMacAddress (Controller
, &MacAddress
, &HwAddressSize
);
823 ASSERT (Status
== EFI_SUCCESS
);
824 VlanId
= NetLibGetVlanId (Controller
);
826 IScsiMacAddrToStr (&MacAddress
, (UINT32
) HwAddressSize
, VlanId
, ConfigFormEntry
->MacString
);
829 // Get the normal session configuration data.
831 BufferSize
= sizeof (ConfigFormEntry
->SessionConfigData
);
832 Status
= gRT
->GetVariable (
833 ConfigFormEntry
->MacString
,
834 &gEfiIScsiInitiatorNameProtocolGuid
,
837 &ConfigFormEntry
->SessionConfigData
839 if (EFI_ERROR (Status
)) {
840 ZeroMem (&ConfigFormEntry
->SessionConfigData
, sizeof (ConfigFormEntry
->SessionConfigData
));
843 // Get the CHAP authentication configuration data.
845 BufferSize
= sizeof (ConfigFormEntry
->AuthConfigData
);
846 Status
= gRT
->GetVariable (
847 ConfigFormEntry
->MacString
,
848 &mIScsiCHAPAuthInfoGuid
,
851 &ConfigFormEntry
->AuthConfigData
853 if (EFI_ERROR (Status
)) {
854 ZeroMem (&ConfigFormEntry
->AuthConfigData
, sizeof (ConfigFormEntry
->AuthConfigData
));
857 // Compose the Port string and create a new EFI_STRING_ID.
859 UnicodeSPrint (PortString
, 128, L
"Port %s", ConfigFormEntry
->MacString
);
860 ConfigFormEntry
->PortTitleToken
= HiiSetString (mCallbackInfo
->RegisteredHandle
, 0, PortString
, NULL
);
863 // Compose the help string of this port and create a new EFI_STRING_ID.
865 UnicodeSPrint (PortString
, 128, L
"Set the iSCSI parameters on port %s", ConfigFormEntry
->MacString
);
866 ConfigFormEntry
->PortTitleHelpToken
= HiiSetString (mCallbackInfo
->RegisteredHandle
, 0, PortString
, NULL
);
868 InsertTailList (&mIScsiConfigFormList
, &ConfigFormEntry
->Link
);
869 mNumberOfIScsiDevices
++;
872 ASSERT (EntryExisted
);
874 mNumberOfIScsiDevices
--;
875 RemoveEntryList (&ConfigFormEntry
->Link
);
876 FreePool (ConfigFormEntry
);
879 // Allocate space for creation of Buffer
883 // Init OpCode Handle
885 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
886 ASSERT (StartOpCodeHandle
!= NULL
);
888 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
889 ASSERT (EndOpCodeHandle
!= NULL
);
892 // Create Hii Extend Label OpCode as the start opcode
894 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
895 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
896 StartLabel
->Number
= DEVICE_ENTRY_LABEL
;
899 // Create Hii Extend Label OpCode as the end opcode
901 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
902 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
903 EndLabel
->Number
= LABEL_END
;
906 NET_LIST_FOR_EACH (Entry
, &mIScsiConfigFormList
) {
907 ConfigFormEntry
= NET_LIST_USER_STRUCT (Entry
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
909 HiiCreateGotoOpCode (
910 StartOpCodeHandle
, // Container for dynamic created opcodes
911 FORMID_DEVICE_FORM
, // Target Form ID
912 ConfigFormEntry
->PortTitleToken
, // Prompt text
913 ConfigFormEntry
->PortTitleHelpToken
, // Help text
914 EFI_IFR_FLAG_CALLBACK
, // Question flag
915 (UINT16
)(KEY_DEVICE_ENTRY_BASE
+ FormIndex
) // Question ID
922 mCallbackInfo
->RegisteredHandle
,
925 StartOpCodeHandle
, // Label DEVICE_ENTRY_LABEL
926 EndOpCodeHandle
// LABEL_END
929 HiiFreeOpCodeHandle (StartOpCodeHandle
);
930 HiiFreeOpCodeHandle (EndOpCodeHandle
);
936 Initialize the iSCSI configuration form.
938 @param[in] DriverBindingHandle The iSCSI driverbinding handle.
940 @retval EFI_SUCCESS The iSCSI configuration form is initialized.
941 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
942 @retval Others Other errors as indicated.
945 IScsiConfigFormInit (
950 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
951 ISCSI_FORM_CALLBACK_INFO
*CallbackInfo
;
953 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**)&HiiDatabase
);
954 if (EFI_ERROR (Status
)) {
958 CallbackInfo
= (ISCSI_FORM_CALLBACK_INFO
*) AllocateZeroPool (sizeof (ISCSI_FORM_CALLBACK_INFO
));
959 if (CallbackInfo
== NULL
) {
960 return EFI_OUT_OF_RESOURCES
;
963 CallbackInfo
->Signature
= ISCSI_FORM_CALLBACK_INFO_SIGNATURE
;
964 CallbackInfo
->HiiDatabase
= HiiDatabase
;
965 CallbackInfo
->Current
= NULL
;
967 CallbackInfo
->ConfigAccess
.ExtractConfig
= IScsiFormExtractConfig
;
968 CallbackInfo
->ConfigAccess
.RouteConfig
= IScsiFormRouteConfig
;
969 CallbackInfo
->ConfigAccess
.Callback
= IScsiFormCallback
;
971 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**)&CallbackInfo
->ConfigRouting
);
972 if (EFI_ERROR (Status
)) {
973 FreePool(CallbackInfo
);
978 // Install Device Path Protocol and Config Access protocol to driver handle
980 Status
= gBS
->InstallMultipleProtocolInterfaces (
981 &CallbackInfo
->DriverHandle
,
982 &gEfiDevicePathProtocolGuid
,
983 &mIScsiHiiVendorDevicePath
,
984 &gEfiHiiConfigAccessProtocolGuid
,
985 &CallbackInfo
->ConfigAccess
,
988 ASSERT_EFI_ERROR (Status
);
991 // Publish our HII data
993 CallbackInfo
->RegisteredHandle
= HiiAddPackages (
995 CallbackInfo
->DriverHandle
,
1000 if (CallbackInfo
->RegisteredHandle
== NULL
) {
1001 FreePool(CallbackInfo
);
1002 return EFI_OUT_OF_RESOURCES
;
1005 mCallbackInfo
= CallbackInfo
;
1011 Unload the iSCSI configuration form, this includes: delete all the iSCSI
1012 device configuration entries, uninstall the form callback protocol and
1013 free the resources used.
1015 @param[in] DriverBindingHandle The iSCSI driverbinding handle.
1017 @retval EFI_SUCCESS The iSCSI configuration form is unloaded.
1018 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1021 IScsiConfigFormUnload (
1022 IN EFI_HANDLE DriverBindingHandle
1025 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
1027 while (!IsListEmpty (&mIScsiConfigFormList
)) {
1029 // Uninstall the device forms as the iSCSI driver instance may fail to
1030 // control the controller but still install the device configuration form.
1031 // In such case, upon driver unloading, the driver instance's driverbinding.
1032 // stop () won't be called, so we have to take this chance here to uninstall
1035 ConfigFormEntry
= NET_LIST_USER_STRUCT (mIScsiConfigFormList
.ForwardLink
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
1036 IScsiConfigUpdateForm (DriverBindingHandle
, ConfigFormEntry
->Controller
, FALSE
);
1040 // Remove HII package list
1042 mCallbackInfo
->HiiDatabase
->RemovePackageList (
1043 mCallbackInfo
->HiiDatabase
,
1044 mCallbackInfo
->RegisteredHandle
1048 // Uninstall EFI_HII_CONFIG_ACCESS_PROTOCOL
1050 gBS
->UninstallMultipleProtocolInterfaces (
1051 mCallbackInfo
->DriverHandle
,
1052 &gEfiDevicePathProtocolGuid
,
1053 &mIScsiHiiVendorDevicePath
,
1054 &gEfiHiiConfigAccessProtocolGuid
,
1055 &mCallbackInfo
->ConfigAccess
,
1058 FreePool (mCallbackInfo
);