2 Helper functions for configuring or getting the parameters relating to iSCSI.
4 Copyright (c) 2004 - 2008, 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_SIMPLE_NETWORK_PROTOCOL
*Snp
;
88 EFI_SIMPLE_NETWORK_MODE
*Mode
;
89 ISCSI_MAC_INFO
*CurMacInfo
;
90 ISCSI_MAC_INFO TempMacInfo
;
95 // Dump all the handles the Simple Network Protocol is installed on.
97 Status
= gBS
->LocateHandleBuffer (
99 &gEfiSimpleNetworkProtocolGuid
,
104 if (EFI_ERROR (Status
)) {
109 Status
= gRT
->GetVariable (
116 if (Status
== EFI_BUFFER_TOO_SMALL
) {
117 DeviceList
= (ISCSI_DEVICE_LIST
*) AllocatePool (DataSize
);
129 for (HandleIndex
= 0; HandleIndex
< NumHandles
; HandleIndex
++) {
130 gBS
->HandleProtocol (Handles
[HandleIndex
], &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
134 for (Index
= LastDeviceIndex
; Index
< DeviceList
->NumDevice
; Index
++) {
135 CurMacInfo
= &DeviceList
->MacInfo
[Index
];
136 if ((CurMacInfo
->Len
== Mode
->HwAddressSize
) &&
137 (NET_MAC_EQUAL (&CurMacInfo
->Mac
, &Mode
->PermanentAddress
, Mode
->HwAddressSize
))
140 // The previous configured NIC is still here.
142 if (Index
!= LastDeviceIndex
) {
144 // Swap the current MAC address entry with the one indexed by
147 CopyMem (&TempMacInfo
, CurMacInfo
, sizeof (ISCSI_MAC_INFO
));
148 CopyMem (CurMacInfo
, &DeviceList
->MacInfo
[LastDeviceIndex
], sizeof (ISCSI_MAC_INFO
));
149 CopyMem (&DeviceList
->MacInfo
[LastDeviceIndex
], &TempMacInfo
, sizeof (ISCSI_MAC_INFO
));
156 if (LastDeviceIndex
== DeviceList
->NumDevice
) {
161 for (Index
= LastDeviceIndex
; Index
< DeviceList
->NumDevice
; Index
++) {
163 // delete the variables
165 CurMacInfo
= &DeviceList
->MacInfo
[Index
];
166 IScsiMacAddrToStr (&CurMacInfo
->Mac
, CurMacInfo
->Len
, MacString
);
167 gRT
->SetVariable (MacString
, &gEfiIScsiInitiatorNameProtocolGuid
, 0, 0, NULL
);
168 gRT
->SetVariable (MacString
, &mIScsiCHAPAuthInfoGuid
, 0, 0, NULL
);
171 gBS
->FreePool (DeviceList
);
172 } else if (Status
!= EFI_NOT_FOUND
) {
173 gBS
->FreePool (Handles
);
177 // Construct the new iSCSI device list.
179 DeviceListSize
= sizeof (ISCSI_DEVICE_LIST
) + (NumHandles
- 1) * sizeof (ISCSI_MAC_INFO
);
180 DeviceList
= (ISCSI_DEVICE_LIST
*) AllocatePool (DeviceListSize
);
181 DeviceList
->NumDevice
= (UINT8
) NumHandles
;
183 for (Index
= 0; Index
< NumHandles
; Index
++) {
184 gBS
->HandleProtocol (Handles
[Index
], &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
187 CurMacInfo
= &DeviceList
->MacInfo
[Index
];
188 CopyMem (&CurMacInfo
->Mac
, &Mode
->PermanentAddress
, Mode
->HwAddressSize
);
189 CurMacInfo
->Len
= (UINT8
) Mode
->HwAddressSize
;
195 ISCSI_CONFIG_VAR_ATTR
,
200 gBS
->FreePool (DeviceList
);
201 gBS
->FreePool (Handles
);
207 Get the iSCSI configuration form entry by the index of the goto opcode actived.
209 @param[in] Index The 0-based index of the goto opcode actived.
211 @return The iSCSI configuration form entry found.
213 ISCSI_CONFIG_FORM_ENTRY
*
214 IScsiGetConfigFormEntryByIndex (
220 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
223 ConfigFormEntry
= NULL
;
225 NET_LIST_FOR_EACH (Entry
, &mIScsiConfigFormList
) {
226 if (CurrentIndex
== Index
) {
227 ConfigFormEntry
= NET_LIST_USER_STRUCT (Entry
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
234 return ConfigFormEntry
;
238 Convert the iSCSI configuration data into the IFR data.
240 @param[in] ConfigFormEntry The iSCSI configuration form entry.
241 @param[out] IfrNvData The IFR nv data.
244 IScsiConvertDeviceConfigDataToIfrNvData (
245 IN ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
,
246 OUT ISCSI_CONFIG_IFR_NVDATA
*IfrNvData
249 ISCSI_SESSION_CONFIG_NVDATA
*SessionConfigData
;
250 ISCSI_CHAP_AUTH_CONFIG_NVDATA
*AuthConfigData
;
253 // Normal session configuration parameters.
255 SessionConfigData
= &ConfigFormEntry
->SessionConfigData
;
256 IfrNvData
->Enabled
= SessionConfigData
->Enabled
;
258 IfrNvData
->InitiatorInfoFromDhcp
= SessionConfigData
->InitiatorInfoFromDhcp
;
259 IfrNvData
->TargetInfoFromDhcp
= SessionConfigData
->TargetInfoFromDhcp
;
260 IfrNvData
->TargetPort
= SessionConfigData
->TargetPort
;
262 IScsiIpToStr (&SessionConfigData
->LocalIp
, IfrNvData
->LocalIp
);
263 IScsiIpToStr (&SessionConfigData
->SubnetMask
, IfrNvData
->SubnetMask
);
264 IScsiIpToStr (&SessionConfigData
->Gateway
, IfrNvData
->Gateway
);
265 IScsiIpToStr (&SessionConfigData
->TargetIp
, IfrNvData
->TargetIp
);
267 IScsiAsciiStrToUnicodeStr (SessionConfigData
->TargetName
, IfrNvData
->TargetName
);
269 IScsiLunToUnicodeStr (SessionConfigData
->BootLun
, IfrNvData
->BootLun
);
272 // CHAP authentication parameters.
274 AuthConfigData
= &ConfigFormEntry
->AuthConfigData
;
276 IfrNvData
->CHAPType
= AuthConfigData
->CHAPType
;
278 IScsiAsciiStrToUnicodeStr (AuthConfigData
->CHAPName
, IfrNvData
->CHAPName
);
279 IScsiAsciiStrToUnicodeStr (AuthConfigData
->CHAPSecret
, IfrNvData
->CHAPSecret
);
280 IScsiAsciiStrToUnicodeStr (AuthConfigData
->ReverseCHAPName
, IfrNvData
->ReverseCHAPName
);
281 IScsiAsciiStrToUnicodeStr (AuthConfigData
->ReverseCHAPSecret
, IfrNvData
->ReverseCHAPSecret
);
285 This function allows the caller to request the current
286 configuration for one or more named elements. The resulting
287 string is in <ConfigAltResp> format. Any and all alternative
288 configuration strings shall also be appended to the end of the
289 current configuration string. If they are, they must appear
290 after the current configuration. They must contain the same
291 routing (GUID, NAME, PATH) as the current configuration string.
292 They must have an additional description indicating the type of
293 alternative configuration the string represents,
294 "ALTCFG=<StringToken>". That <StringToken> (when
295 converted from Hex UNICODE to binary) is a reference to a
296 string in the associated string pack.
298 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
299 @param[in] Request A null-terminated Unicode string in
300 <ConfigRequest> format. Note that this
301 includes the routing information as well as
302 the configurable name / value pairs. It is
303 invalid for this string to be in
304 <MultiConfigRequest> format.
305 @param[out] Progress On return, points to a character in the
306 Request string. Points to the string's null
307 terminator if request was successful. Points
308 to the most recent "&" before the first
309 failing name / value pair (or the beginning
310 of the string if the failure is in the first
311 name / value pair) if the request was not
313 @param[out] Results A null-terminated Unicode string in
314 <ConfigAltResp> format which has all values
315 filled in for the names in the Request string.
316 String to be allocated by the called function.
318 @retval EFI_SUCCESS The Results string is filled with the
319 values corresponding to all requested
321 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
322 parts of the results that must be
323 stored awaiting possible future
325 @retval EFI_INVALID_PARAMETER For example, passing in a NULL
326 for the Request parameter
327 would result in this type of
328 error. In this case, the
329 Progress parameter would be
331 @retval EFI_NOT_FOUND Routing data doesn't match any
332 known driver. Progress set to the
333 first character in the routing header.
334 Note: There is no requirement that the
335 driver validate the routing data. It
336 must skip the <ConfigHdr> in order to
338 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
339 to most recent & before the
340 error or the beginning of the
342 @retval EFI_INVALID_PARAMETER Unknown name. Progress points
343 to the & before the name in
344 question.Currently not implemented.
348 IScsiFormExtractConfig (
349 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
350 IN CONST EFI_STRING Request
,
351 OUT EFI_STRING
*Progress
,
352 OUT EFI_STRING
*Results
356 CHAR8 InitiatorName
[ISCSI_NAME_IFR_MAX_SIZE
];
358 ISCSI_CONFIG_IFR_NVDATA
*IfrNvData
;
359 ISCSI_FORM_CALLBACK_INFO
*Private
;
360 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
362 if (Request
== NULL
) {
363 return EFI_INVALID_PARAMETER
;
366 if (!mIScsiDeviceListUpdated
) {
368 // Update the device list.
370 IScsiUpdateDeviceList ();
371 mIScsiDeviceListUpdated
= TRUE
;
374 Private
= ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This
);
375 IfrNvData
= AllocateZeroPool (sizeof (ISCSI_CONFIG_IFR_NVDATA
));
376 ASSERT (IfrNvData
!= NULL
);
377 if (Private
->Current
!= NULL
) {
378 IScsiConvertDeviceConfigDataToIfrNvData (Private
->Current
, IfrNvData
);
381 BufferSize
= ISCSI_NAME_IFR_MAX_SIZE
;
382 Status
= gIScsiInitiatorName
.Get (&gIScsiInitiatorName
, &BufferSize
, InitiatorName
);
383 if (EFI_ERROR (Status
)) {
384 IfrNvData
->InitiatorName
[0] = L
'\0';
386 IScsiAsciiStrToUnicodeStr (InitiatorName
, IfrNvData
->InitiatorName
);
390 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
392 HiiConfigRouting
= Private
->ConfigRouting
;
393 BufferSize
= sizeof (ISCSI_CONFIG_IFR_NVDATA
);
394 Status
= HiiConfigRouting
->BlockToConfig (
402 gBS
->FreePool (IfrNvData
);
407 This function applies changes in a driver's configuration.
408 Input is a Configuration, which has the routing data for this
409 driver followed by name / value configuration pairs. The driver
410 must apply those pairs to its configurable storage. If the
411 driver's configuration is stored in a linear block of data
412 and the driver's name / value pairs are in <BlockConfig>
413 format, it may use the ConfigToBlock helper function (above) to
414 simplify the job. Currently not implemented.
416 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
417 @param[in] Configuration A null-terminated Unicode string in
418 <ConfigString> format.
419 @param[out] Progress A pointer to a string filled in with the
420 offset of the most recent '&' before the
421 first failing name / value pair (or the
422 beginn ing of the string if the failure
423 is in the first name / value pair) or
424 the terminating NULL if all was
427 @retval EFI_SUCCESS The results have been distributed or are
428 awaiting distribution.
429 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
430 parts of the results that must be
431 stored awaiting possible future
433 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
434 Results parameter would result
435 in this type of error.
436 @retval EFI_NOT_FOUND Target for the specified routing data
441 IScsiFormRouteConfig (
442 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
443 IN CONST EFI_STRING Configuration
,
444 OUT EFI_STRING
*Progress
451 This function is called to provide results data to the driver.
452 This data consists of a unique key that is used to identify
453 which data is either being passed back or being asked for.
455 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
456 @param[in] Action Specifies the type of action taken by the browser.
457 @param[in] QuestionId A unique value which is sent to the original
458 exporting driver so that it can identify the type
459 of data to expect. The format of the data tends to
460 vary based on the opcode that enerated the callback.
461 @param[in] Type The type of value for the question.
462 @param[in] Value A pointer to the data being sent to the original
464 @param[out] ActionRequest On return, points to the action requested by the
467 @retval EFI_SUCCESS The callback successfully handled the action.
468 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
469 variable and its data.
470 @retval EFI_DEVICE_ERROR The variable could not be saved.
471 @retval EFI_UNSUPPORTED The specified Action is not supported by the
472 callback.Currently not implemented.
473 @retval EFI_INVALID_PARAMETERS Passing in wrong parameter.
474 @retval Others Other errors as indicated.
479 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
480 IN EFI_BROWSER_ACTION Action
,
481 IN EFI_QUESTION_ID QuestionId
,
483 IN EFI_IFR_TYPE_VALUE
*Value
,
484 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
487 ISCSI_FORM_CALLBACK_INFO
*Private
;
489 CHAR8 IScsiName
[ISCSI_NAME_IFR_MAX_SIZE
];
490 CHAR16 PortString
[128];
491 CHAR8 Ip4String
[IP4_STR_MAX_SIZE
];
492 CHAR8 LunString
[ISCSI_LUN_STR_MAX_LEN
];
494 EFI_STRING_ID DeviceFormTitleToken
;
495 ISCSI_CONFIG_IFR_NVDATA
*IfrNvData
;
496 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
497 EFI_IP_ADDRESS HostIp
;
498 EFI_IP_ADDRESS SubnetMask
;
499 EFI_IP_ADDRESS Gateway
;
503 Private
= ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This
);
506 // Retrive uncommitted data from Browser
508 IfrNvData
= AllocateZeroPool (sizeof (ISCSI_CONFIG_IFR_NVDATA
));
509 ASSERT (IfrNvData
!= NULL
);
510 if (!HiiGetBrowserData (&mVendorGuid
, mVendorStorageName
, sizeof (ISCSI_CONFIG_IFR_NVDATA
), (UINT8
*) IfrNvData
)) {
511 FreePool (IfrNvData
);
512 return EFI_NOT_FOUND
;
515 Status
= EFI_SUCCESS
;
517 switch (QuestionId
) {
518 case KEY_INITIATOR_NAME
:
519 IScsiUnicodeStrToAsciiStr (IfrNvData
->InitiatorName
, IScsiName
);
520 BufferSize
= AsciiStrLen (IScsiName
) + 1;
522 Status
= gIScsiInitiatorName
.Set (&gIScsiInitiatorName
, &BufferSize
, IScsiName
);
523 if (EFI_ERROR (Status
)) {
524 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid iSCSI Name!", NULL
);
530 IScsiUnicodeStrToAsciiStr (IfrNvData
->LocalIp
, Ip4String
);
531 Status
= IScsiAsciiStrToIp (Ip4String
, &HostIp
.v4
);
532 if (EFI_ERROR (Status
) || !Ip4IsUnicast (NTOHL (HostIp
.Addr
[0]), 0)) {
533 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid IP address!", NULL
);
534 Status
= EFI_INVALID_PARAMETER
;
536 CopyMem (&Private
->Current
->SessionConfigData
.LocalIp
, &HostIp
.v4
, sizeof (HostIp
.v4
));
541 case KEY_SUBNET_MASK
:
542 IScsiUnicodeStrToAsciiStr (IfrNvData
->SubnetMask
, Ip4String
);
543 Status
= IScsiAsciiStrToIp (Ip4String
, &SubnetMask
.v4
);
544 if (EFI_ERROR (Status
) || ((SubnetMask
.Addr
[0] != 0) && (IScsiGetSubnetMaskPrefixLength (&SubnetMask
.v4
) == 0))) {
545 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid Subnet Mask!", NULL
);
546 Status
= EFI_INVALID_PARAMETER
;
548 CopyMem (&Private
->Current
->SessionConfigData
.SubnetMask
, &SubnetMask
.v4
, sizeof (SubnetMask
.v4
));
554 IScsiUnicodeStrToAsciiStr (IfrNvData
->Gateway
, Ip4String
);
555 Status
= IScsiAsciiStrToIp (Ip4String
, &Gateway
.v4
);
556 if (EFI_ERROR (Status
) || ((Gateway
.Addr
[0] != 0) && !Ip4IsUnicast (NTOHL (Gateway
.Addr
[0]), 0))) {
557 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid Gateway!", NULL
);
558 Status
= EFI_INVALID_PARAMETER
;
560 CopyMem (&Private
->Current
->SessionConfigData
.Gateway
, &Gateway
.v4
, sizeof (Gateway
.v4
));
566 IScsiUnicodeStrToAsciiStr (IfrNvData
->TargetIp
, Ip4String
);
567 Status
= IScsiAsciiStrToIp (Ip4String
, &HostIp
.v4
);
568 if (EFI_ERROR (Status
) || !Ip4IsUnicast (NTOHL (HostIp
.Addr
[0]), 0)) {
569 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid IP address!", NULL
);
570 Status
= EFI_INVALID_PARAMETER
;
572 CopyMem (&Private
->Current
->SessionConfigData
.TargetIp
, &HostIp
.v4
, sizeof (HostIp
.v4
));
577 case KEY_TARGET_NAME
:
578 IScsiUnicodeStrToAsciiStr (IfrNvData
->TargetName
, IScsiName
);
579 Status
= IScsiNormalizeName (IScsiName
, AsciiStrLen (IScsiName
));
580 if (EFI_ERROR (Status
)) {
581 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid iSCSI Name!", NULL
);
583 AsciiStrCpy (Private
->Current
->SessionConfigData
.TargetName
, IScsiName
);
588 case KEY_DHCP_ENABLE
:
589 if (IfrNvData
->InitiatorInfoFromDhcp
== 0) {
590 IfrNvData
->TargetInfoFromDhcp
= 0;
596 IScsiUnicodeStrToAsciiStr (IfrNvData
->BootLun
, LunString
);
597 Status
= IScsiAsciiStrToLun (LunString
, (UINT8
*) &Lun
);
598 if (EFI_ERROR (Status
)) {
599 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Invalid LUN string!", NULL
);
601 CopyMem (Private
->Current
->SessionConfigData
.BootLun
, &Lun
, sizeof (Lun
));
607 IScsiUnicodeStrToAsciiStr (IfrNvData
->CHAPName
, Private
->Current
->AuthConfigData
.CHAPName
);
610 case KEY_CHAP_SECRET
:
611 IScsiUnicodeStrToAsciiStr (IfrNvData
->CHAPSecret
, Private
->Current
->AuthConfigData
.CHAPSecret
);
614 case KEY_REVERSE_CHAP_NAME
:
615 IScsiUnicodeStrToAsciiStr (IfrNvData
->ReverseCHAPName
, Private
->Current
->AuthConfigData
.ReverseCHAPName
);
618 case KEY_REVERSE_CHAP_SECRET
:
619 IScsiUnicodeStrToAsciiStr (IfrNvData
->ReverseCHAPSecret
, Private
->Current
->AuthConfigData
.ReverseCHAPSecret
);
622 case KEY_SAVE_CHANGES
:
624 // First, update those fields which don't have INTERACTIVE set.
626 Private
->Current
->SessionConfigData
.Enabled
= IfrNvData
->Enabled
;
627 Private
->Current
->SessionConfigData
.InitiatorInfoFromDhcp
= IfrNvData
->InitiatorInfoFromDhcp
;
628 Private
->Current
->SessionConfigData
.TargetPort
= IfrNvData
->TargetPort
;
629 if (Private
->Current
->SessionConfigData
.TargetPort
== 0) {
630 Private
->Current
->SessionConfigData
.TargetPort
= ISCSI_WELL_KNOWN_PORT
;
633 Private
->Current
->SessionConfigData
.TargetInfoFromDhcp
= IfrNvData
->TargetInfoFromDhcp
;
634 Private
->Current
->AuthConfigData
.CHAPType
= IfrNvData
->CHAPType
;
637 // Only do full parameter validation if iSCSI is enabled on this device.
639 if (Private
->Current
->SessionConfigData
.Enabled
) {
641 // Validate the address configuration of the Initiator if DHCP isn't
644 if (!Private
->Current
->SessionConfigData
.InitiatorInfoFromDhcp
) {
645 CopyMem (&HostIp
.v4
, &Private
->Current
->SessionConfigData
.LocalIp
, sizeof (HostIp
.v4
));
646 CopyMem (&SubnetMask
.v4
, &Private
->Current
->SessionConfigData
.SubnetMask
, sizeof (SubnetMask
.v4
));
647 CopyMem (&Gateway
.v4
, &Private
->Current
->SessionConfigData
.Gateway
, sizeof (Gateway
.v4
));
649 if ((Gateway
.Addr
[0] != 0)) {
650 if (SubnetMask
.Addr
[0] == 0) {
651 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Gateway address is set but subnet mask is zero.", NULL
);
652 Status
= EFI_INVALID_PARAMETER
;
654 } else if (!IP4_NET_EQUAL (HostIp
.Addr
[0], Gateway
.Addr
[0], SubnetMask
.Addr
[0])) {
655 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Local IP and Gateway are not in the same subnet.", NULL
);
656 Status
= EFI_INVALID_PARAMETER
;
662 // Validate target configuration if DHCP isn't deployed.
664 if (!Private
->Current
->SessionConfigData
.TargetInfoFromDhcp
) {
665 CopyMem (&HostIp
.v4
, &Private
->Current
->SessionConfigData
.TargetIp
, sizeof (HostIp
.v4
));
666 if (!Ip4IsUnicast (NTOHL (HostIp
.Addr
[0]), 0)) {
667 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Target IP is invalid!", NULL
);
668 Status
= EFI_INVALID_PARAMETER
;
673 if (IfrNvData
->CHAPType
!= ISCSI_CHAP_NONE
) {
674 if ((IfrNvData
->CHAPName
[0] == '\0') || (IfrNvData
->CHAPSecret
[0] == '\0')) {
675 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"CHAP Name or CHAP Secret is invalid!", NULL
);
676 Status
= EFI_INVALID_PARAMETER
;
680 if ((IfrNvData
->CHAPType
== ISCSI_CHAP_MUTUAL
) &&
681 ((IfrNvData
->ReverseCHAPName
[0] == '\0') || (IfrNvData
->ReverseCHAPSecret
[0] == '\0'))
683 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, L
"Reverse CHAP Name or Reverse CHAP Secret is invalid!", NULL
);
684 Status
= EFI_INVALID_PARAMETER
;
690 BufferSize
= sizeof (Private
->Current
->SessionConfigData
);
692 Private
->Current
->MacString
,
693 &gEfiIScsiInitiatorNameProtocolGuid
,
694 ISCSI_CONFIG_VAR_ATTR
,
696 &Private
->Current
->SessionConfigData
699 BufferSize
= sizeof (Private
->Current
->AuthConfigData
);
701 Private
->Current
->MacString
,
702 &mIScsiCHAPAuthInfoGuid
,
703 ISCSI_CONFIG_VAR_ATTR
,
705 &Private
->Current
->AuthConfigData
707 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
711 if ((QuestionId
>= KEY_DEVICE_ENTRY_BASE
) && (QuestionId
< (mNumberOfIScsiDevices
+ KEY_DEVICE_ENTRY_BASE
))) {
713 // In case goto the device configuration form, update the device form title.
715 ConfigFormEntry
= IScsiGetConfigFormEntryByIndex ((UINT32
) (QuestionId
- KEY_DEVICE_ENTRY_BASE
));
716 ASSERT (ConfigFormEntry
!= NULL
);
718 UnicodeSPrint (PortString
, (UINTN
) 128, L
"Port %s", ConfigFormEntry
->MacString
);
719 DeviceFormTitleToken
= (EFI_STRING_ID
) STR_ISCSI_DEVICE_FORM_TITLE
;
720 HiiSetString (Private
->RegisteredHandle
, DeviceFormTitleToken
, PortString
, NULL
);
722 IScsiConvertDeviceConfigDataToIfrNvData (ConfigFormEntry
, IfrNvData
);
724 Private
->Current
= ConfigFormEntry
;
730 if (!EFI_ERROR (Status
)) {
732 // Pass changed uncommitted data back to Form Browser
734 HiiSetBrowserData (&mVendorGuid
, mVendorStorageName
, sizeof (ISCSI_CONFIG_IFR_NVDATA
), (UINT8
*) IfrNvData
, NULL
);
737 FreePool (IfrNvData
);
742 Updates the iSCSI configuration form to add/delete an entry for the iSCSI
743 device specified by the Controller.
745 @param[in] DriverBindingHandle The driverbinding handle.
746 @param[in] Controller The controller handle of the iSCSI device.
747 @param[in] AddForm Whether to add or delete a form entry.
749 @retval EFI_SUCCESS The iSCSI configuration form is updated.
750 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
751 @retval Others Other errors as indicated.
754 IScsiConfigUpdateForm (
755 IN EFI_HANDLE DriverBindingHandle
,
756 IN EFI_HANDLE Controller
,
761 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
762 BOOLEAN EntryExisted
;
764 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
765 CHAR16 PortString
[128];
768 VOID
*StartOpCodeHandle
;
769 VOID
*EndOpCodeHandle
;
770 EFI_IFR_GUID_LABEL
*StartLabel
;
771 EFI_IFR_GUID_LABEL
*EndLabel
;
773 ConfigFormEntry
= NULL
;
774 EntryExisted
= FALSE
;
776 NET_LIST_FOR_EACH (Entry
, &mIScsiConfigFormList
) {
777 ConfigFormEntry
= NET_LIST_USER_STRUCT (Entry
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
779 if (ConfigFormEntry
->Controller
== Controller
) {
792 ConfigFormEntry
= (ISCSI_CONFIG_FORM_ENTRY
*) AllocateZeroPool (sizeof (ISCSI_CONFIG_FORM_ENTRY
));
793 if (ConfigFormEntry
== NULL
) {
794 return EFI_OUT_OF_RESOURCES
;
797 InitializeListHead (&ConfigFormEntry
->Link
);
798 ConfigFormEntry
->Controller
= Controller
;
801 // Get the simple network protocol and convert the MAC address into
802 // the formatted string.
804 Status
= gBS
->HandleProtocol (
806 &gEfiSimpleNetworkProtocolGuid
,
809 ASSERT (Status
== EFI_SUCCESS
);
811 IScsiMacAddrToStr (&Snp
->Mode
->PermanentAddress
, Snp
->Mode
->HwAddressSize
, ConfigFormEntry
->MacString
);
814 // Get the normal session configuration data.
816 BufferSize
= sizeof (ConfigFormEntry
->SessionConfigData
);
817 Status
= gRT
->GetVariable (
818 ConfigFormEntry
->MacString
,
819 &gEfiIScsiInitiatorNameProtocolGuid
,
822 &ConfigFormEntry
->SessionConfigData
824 if (EFI_ERROR (Status
)) {
825 ZeroMem (&ConfigFormEntry
->SessionConfigData
, sizeof (ConfigFormEntry
->SessionConfigData
));
828 // Get the CHAP authentication configuration data.
830 BufferSize
= sizeof (ConfigFormEntry
->AuthConfigData
);
831 Status
= gRT
->GetVariable (
832 ConfigFormEntry
->MacString
,
833 &mIScsiCHAPAuthInfoGuid
,
836 &ConfigFormEntry
->AuthConfigData
838 if (EFI_ERROR (Status
)) {
839 ZeroMem (&ConfigFormEntry
->AuthConfigData
, sizeof (ConfigFormEntry
->AuthConfigData
));
842 // Compose the Port string and create a new EFI_STRING_ID.
844 UnicodeSPrint (PortString
, 128, L
"Port %s", ConfigFormEntry
->MacString
);
845 ConfigFormEntry
->PortTitleToken
= HiiSetString (mCallbackInfo
->RegisteredHandle
, 0, PortString
, NULL
);
848 // Compose the help string of this port and create a new EFI_STRING_ID.
850 UnicodeSPrint (PortString
, 128, L
"Set the iSCSI parameters on port %s", ConfigFormEntry
->MacString
);
851 ConfigFormEntry
->PortTitleHelpToken
= HiiSetString (mCallbackInfo
->RegisteredHandle
, 0, PortString
, NULL
);
853 InsertTailList (&mIScsiConfigFormList
, &ConfigFormEntry
->Link
);
854 mNumberOfIScsiDevices
++;
857 ASSERT (EntryExisted
);
859 mNumberOfIScsiDevices
--;
860 RemoveEntryList (&ConfigFormEntry
->Link
);
861 gBS
->FreePool (ConfigFormEntry
);
864 // Allocate space for creation of Buffer
868 // Init OpCode Handle
870 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
871 ASSERT (StartOpCodeHandle
!= NULL
);
873 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
874 ASSERT (EndOpCodeHandle
!= NULL
);
877 // Create Hii Extend Label OpCode as the start opcode
879 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
880 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
881 StartLabel
->Number
= DEVICE_ENTRY_LABEL
;
884 // Create Hii Extend Label OpCode as the end opcode
886 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
887 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
888 EndLabel
->Number
= LABEL_END
;
891 NET_LIST_FOR_EACH (Entry
, &mIScsiConfigFormList
) {
892 ConfigFormEntry
= NET_LIST_USER_STRUCT (Entry
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
894 HiiCreateGotoOpCode (
895 StartOpCodeHandle
, // Container for dynamic created opcodes
896 FORMID_DEVICE_FORM
, // Target Form ID
897 ConfigFormEntry
->PortTitleToken
, // Prompt text
898 ConfigFormEntry
->PortTitleHelpToken
, // Help text
899 EFI_IFR_FLAG_CALLBACK
, // Question flag
900 (UINT16
)(KEY_DEVICE_ENTRY_BASE
+ FormIndex
) // Question ID
907 mCallbackInfo
->RegisteredHandle
,
910 StartOpCodeHandle
, // Label DEVICE_ENTRY_LABEL
911 EndOpCodeHandle
// LABEL_END
914 HiiFreeOpCodeHandle (StartOpCodeHandle
);
915 HiiFreeOpCodeHandle (EndOpCodeHandle
);
921 Initialize the iSCSI configuration form.
923 @param[in] DriverBindingHandle The iSCSI driverbinding handle.
925 @retval EFI_SUCCESS The iSCSI configuration form is initialized.
926 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
927 @retval Others Other errors as indicated.
930 IScsiConfigFormInit (
935 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
936 ISCSI_FORM_CALLBACK_INFO
*CallbackInfo
;
938 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**)&HiiDatabase
);
939 if (EFI_ERROR (Status
)) {
943 CallbackInfo
= (ISCSI_FORM_CALLBACK_INFO
*) AllocateZeroPool (sizeof (ISCSI_FORM_CALLBACK_INFO
));
944 if (CallbackInfo
== NULL
) {
945 return EFI_OUT_OF_RESOURCES
;
948 CallbackInfo
->Signature
= ISCSI_FORM_CALLBACK_INFO_SIGNATURE
;
949 CallbackInfo
->HiiDatabase
= HiiDatabase
;
950 CallbackInfo
->Current
= NULL
;
952 CallbackInfo
->ConfigAccess
.ExtractConfig
= IScsiFormExtractConfig
;
953 CallbackInfo
->ConfigAccess
.RouteConfig
= IScsiFormRouteConfig
;
954 CallbackInfo
->ConfigAccess
.Callback
= IScsiFormCallback
;
956 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**)&CallbackInfo
->ConfigRouting
);
957 if (EFI_ERROR (Status
)) {
958 FreePool(CallbackInfo
);
963 // Install Device Path Protocol and Config Access protocol to driver handle
965 Status
= gBS
->InstallMultipleProtocolInterfaces (
966 &CallbackInfo
->DriverHandle
,
967 &gEfiDevicePathProtocolGuid
,
968 &mIScsiHiiVendorDevicePath
,
969 &gEfiHiiConfigAccessProtocolGuid
,
970 &CallbackInfo
->ConfigAccess
,
973 ASSERT_EFI_ERROR (Status
);
976 // Publish our HII data
978 CallbackInfo
->RegisteredHandle
= HiiAddPackages (
980 CallbackInfo
->DriverHandle
,
985 if (CallbackInfo
->RegisteredHandle
== NULL
) {
986 FreePool(CallbackInfo
);
987 return EFI_OUT_OF_RESOURCES
;
990 mCallbackInfo
= CallbackInfo
;
996 Unload the iSCSI configuration form, this includes: delete all the iSCSI
997 device configuration entries, uninstall the form callback protocol and
998 free the resources used.
1000 @param[in] DriverBindingHandle The iSCSI driverbinding handle.
1002 @retval EFI_SUCCESS The iSCSI configuration form is unloaded.
1003 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1006 IScsiConfigFormUnload (
1007 IN EFI_HANDLE DriverBindingHandle
1010 ISCSI_CONFIG_FORM_ENTRY
*ConfigFormEntry
;
1012 while (!IsListEmpty (&mIScsiConfigFormList
)) {
1014 // Uninstall the device forms as the iSCSI driver instance may fail to
1015 // control the controller but still install the device configuration form.
1016 // In such case, upon driver unloading, the driver instance's driverbinding.
1017 // stop () won't be called, so we have to take this chance here to uninstall
1020 ConfigFormEntry
= NET_LIST_USER_STRUCT (mIScsiConfigFormList
.ForwardLink
, ISCSI_CONFIG_FORM_ENTRY
, Link
);
1021 IScsiConfigUpdateForm (DriverBindingHandle
, ConfigFormEntry
->Controller
, FALSE
);
1025 // Remove HII package list
1027 mCallbackInfo
->HiiDatabase
->RemovePackageList (
1028 mCallbackInfo
->HiiDatabase
,
1029 mCallbackInfo
->RegisteredHandle
1033 // Uninstall EFI_HII_CONFIG_ACCESS_PROTOCOL
1035 gBS
->UninstallMultipleProtocolInterfaces (
1036 mCallbackInfo
->DriverHandle
,
1037 &gEfiDevicePathProtocolGuid
,
1038 &mIScsiHiiVendorDevicePath
,
1039 &gEfiHiiConfigAccessProtocolGuid
,
1040 &mCallbackInfo
->ConfigAccess
,
1043 gBS
->FreePool (mCallbackInfo
);