2 iSCSI DHCP6 related configuration routines.
4 Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
5 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"
19 Extract the Root Path option and get the required target information from
20 Boot File Uniform Resource Locator (URL) Option.
22 @param[in] RootPath The RootPath string.
23 @param[in] Length Length of the RootPath option payload.
24 @param[in, out] ConfigData The iSCSI session configuration data read from
27 @retval EFI_SUCCESS All required information is extracted from the
29 @retval EFI_NOT_FOUND The RootPath is not an iSCSI RootPath.
30 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
31 @retval EFI_INVALID_PARAMETER The RootPath is malformatted.
35 IScsiDhcp6ExtractRootPath (
38 IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA
*ConfigData
42 UINT16 IScsiRootPathIdLen
;
44 ISCSI_ROOT_PATH_FIELD Fields
[RP_FIELD_IDX_MAX
];
45 ISCSI_ROOT_PATH_FIELD
*Field
;
48 ISCSI_SESSION_CONFIG_NVDATA
*ConfigNvData
;
52 ConfigNvData
= &ConfigData
->SessionConfigData
;
55 // "iscsi:"<servername>":"<protocol>":"<port>":"<LUN>":"<targetname>
57 IScsiRootPathIdLen
= (UINT16
) AsciiStrLen (ISCSI_ROOT_PATH_ID
);
59 if ((Length
<= IScsiRootPathIdLen
) ||
60 (CompareMem (RootPath
, ISCSI_ROOT_PATH_ID
, IScsiRootPathIdLen
) != 0)) {
64 // Skip the iSCSI RootPath ID "iscsi:".
66 RootPath
= RootPath
+ IScsiRootPathIdLen
;
67 Length
= (UINT16
) (Length
- IScsiRootPathIdLen
);
69 TmpStr
= (CHAR8
*) AllocatePool (Length
+ 1);
71 return EFI_OUT_OF_RESOURCES
;
74 CopyMem (TmpStr
, RootPath
, Length
);
75 TmpStr
[Length
] = '\0';
79 ZeroMem (&Fields
[0], sizeof (Fields
));
82 // Extract SERVERNAME field in the Root Path option.
84 if (TmpStr
[Index
] != ISCSI_ROOT_PATH_ADDR_START_DELIMITER
) {
85 Status
= EFI_INVALID_PARAMETER
;
91 Fields
[RP_FIELD_IDX_SERVERNAME
].Str
= &TmpStr
[Index
];
93 while ((TmpStr
[Index
] != ISCSI_ROOT_PATH_ADDR_END_DELIMITER
) && (Index
< Length
)) {
100 TmpStr
[Index
] = '\0';
103 Fields
[RP_FIELD_IDX_SERVERNAME
].Len
= (UINT8
) AsciiStrLen (Fields
[RP_FIELD_IDX_SERVERNAME
].Str
);
106 // Extract others fields in the Root Path option string.
108 for (FieldIndex
= 1; (FieldIndex
< RP_FIELD_IDX_MAX
) && (Index
< Length
); FieldIndex
++) {
110 if (TmpStr
[Index
] != ISCSI_ROOT_PATH_FIELD_DELIMITER
) {
111 Fields
[FieldIndex
].Str
= &TmpStr
[Index
];
114 while ((TmpStr
[Index
] != ISCSI_ROOT_PATH_FIELD_DELIMITER
) && (Index
< Length
)) {
118 if (TmpStr
[Index
] == ISCSI_ROOT_PATH_FIELD_DELIMITER
) {
119 if (FieldIndex
!= RP_FIELD_IDX_TARGETNAME
) {
120 TmpStr
[Index
] = '\0';
124 if (Fields
[FieldIndex
].Str
!= NULL
) {
125 Fields
[FieldIndex
].Len
= (UINT8
) AsciiStrLen (Fields
[FieldIndex
].Str
);
130 if (FieldIndex
!= RP_FIELD_IDX_MAX
) {
131 Status
= EFI_INVALID_PARAMETER
;
135 if ((Fields
[RP_FIELD_IDX_SERVERNAME
].Str
== NULL
) ||
136 (Fields
[RP_FIELD_IDX_TARGETNAME
].Str
== NULL
) ||
137 (Fields
[RP_FIELD_IDX_PROTOCOL
].Len
> 1)
140 Status
= EFI_INVALID_PARAMETER
;
144 // Get the IP address of the target.
146 Field
= &Fields
[RP_FIELD_IDX_SERVERNAME
];
147 if (ConfigNvData
->IpMode
< IP_MODE_AUTOCONFIG
) {
148 IpMode
= ConfigNvData
->IpMode
;
150 IpMode
= ConfigData
->AutoConfigureMode
;
153 Status
= IScsiAsciiStrToIp (Field
->Str
, IpMode
, &Ip
);
154 CopyMem (&ConfigNvData
->TargetIp
, &Ip
, sizeof (EFI_IP_ADDRESS
));
157 if (EFI_ERROR (Status
)) {
161 // Check the protocol type.
163 Field
= &Fields
[RP_FIELD_IDX_PROTOCOL
];
164 if ((Field
->Str
!= NULL
) && ((*(Field
->Str
) - '0') != EFI_IP_PROTO_TCP
)) {
165 Status
= EFI_INVALID_PARAMETER
;
169 // Get the port of the iSCSI target.
171 Field
= &Fields
[RP_FIELD_IDX_PORT
];
172 if (Field
->Str
!= NULL
) {
173 ConfigNvData
->TargetPort
= (UINT16
) AsciiStrDecimalToUintn (Field
->Str
);
175 ConfigNvData
->TargetPort
= ISCSI_WELL_KNOWN_PORT
;
180 Field
= &Fields
[RP_FIELD_IDX_LUN
];
181 if (Field
->Str
!= NULL
) {
182 Status
= IScsiAsciiStrToLun (Field
->Str
, ConfigNvData
->BootLun
);
183 if (EFI_ERROR (Status
)) {
187 ZeroMem (ConfigNvData
->BootLun
, sizeof (ConfigNvData
->BootLun
));
190 // Get the target iSCSI Name.
192 Field
= &Fields
[RP_FIELD_IDX_TARGETNAME
];
194 if (AsciiStrLen (Field
->Str
) > ISCSI_NAME_MAX_SIZE
- 1) {
195 Status
= EFI_INVALID_PARAMETER
;
199 // Validate the iSCSI name.
201 Status
= IScsiNormalizeName (Field
->Str
, AsciiStrLen (Field
->Str
));
202 if (EFI_ERROR (Status
)) {
206 AsciiStrCpy (ConfigNvData
->TargetName
, Field
->Str
);
216 EFI_DHCP6_INFO_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol
217 instance to intercept events that occurs in the DHCPv6 Information Request
220 @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that
221 is used to configure this callback function.
222 @param[in] Context Pointer to the context that is initialized in
223 the EFI_DHCP6_PROTOCOL.InfoRequest().
224 @param[in] Packet Pointer to Reply packet that has been received.
225 The EFI DHCPv6 Protocol instance is responsible
226 for freeing the buffer.
228 @retval EFI_SUCCESS Tell the EFI DHCPv6 Protocol instance to finish
229 Information Request exchange process.
230 @retval EFI_NOT_READY Tell the EFI DHCPv6 Protocol instance to continue
231 Information Request exchange process.
232 @retval EFI_ABORTED Tell the EFI DHCPv6 Protocol instance to abort
233 the Information Request exchange process.
234 @retval EFI_UNSUPPORTED Tell the EFI DHCPv6 Protocol instance to finish
235 the Information Request exchange process because some
236 request information are not received.
241 IScsiDhcp6ParseReply (
242 IN EFI_DHCP6_PROTOCOL
*This
,
244 IN EFI_DHCP6_PACKET
*Packet
250 EFI_DHCP6_PACKET_OPTION
*BootFileOpt
;
251 EFI_DHCP6_PACKET_OPTION
**OptionList
;
252 ISCSI_ATTEMPT_CONFIG_NVDATA
*ConfigData
;
258 Status
= This
->Parse (This
, Packet
, &OptionCount
, NULL
);
259 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
260 return EFI_NOT_READY
;
263 OptionList
= AllocateZeroPool (OptionCount
* sizeof (EFI_DHCP6_PACKET_OPTION
*));
264 if (OptionList
== NULL
) {
265 return EFI_NOT_READY
;
268 Status
= This
->Parse (This
, Packet
, &OptionCount
, OptionList
);
269 if (EFI_ERROR (Status
)) {
270 Status
= EFI_NOT_READY
;
274 ConfigData
= (ISCSI_ATTEMPT_CONFIG_NVDATA
*) Context
;
276 for (Index
= 0; Index
< OptionCount
; Index
++) {
277 OptionList
[Index
]->OpCode
= NTOHS (OptionList
[Index
]->OpCode
);
278 OptionList
[Index
]->OpLen
= NTOHS (OptionList
[Index
]->OpLen
);
281 // Get DNS server addresses from this reply packet.
283 if (OptionList
[Index
]->OpCode
== DHCP6_OPT_DNS_SERVERS
) {
285 if (((OptionList
[Index
]->OpLen
& 0xf) != 0) || (OptionList
[Index
]->OpLen
== 0)) {
286 Status
= EFI_UNSUPPORTED
;
290 // Primary DNS server address.
292 CopyMem (&ConfigData
->PrimaryDns
, &OptionList
[Index
]->Data
[0], sizeof (EFI_IPv6_ADDRESS
));
294 if (OptionList
[Index
]->OpLen
> 16) {
296 // Secondary DNS server address
298 CopyMem (&ConfigData
->SecondaryDns
, &OptionList
[Index
]->Data
[16], sizeof (EFI_IPv6_ADDRESS
));
301 } else if (OptionList
[Index
]->OpCode
== DHCP6_OPT_BOOT_FILE_URL
) {
303 // The server sends this option to inform the client about an URL to a boot file.
305 BootFileOpt
= OptionList
[Index
];
306 } else if (OptionList
[Index
]->OpCode
== DHCP6_OPT_BOOT_FILE_PARA
) {
308 // The server sends this option to inform the client about DHCP6 server address.
310 if (OptionList
[Index
]->OpLen
< 18) {
311 Status
= EFI_UNSUPPORTED
;
315 // Check param-len 1, should be 16 bytes.
317 CopyMem (&ParaLen
, &OptionList
[Index
]->Data
[0], sizeof (UINT16
));
318 if (NTOHS (ParaLen
) != 16) {
319 Status
= EFI_UNSUPPORTED
;
323 CopyMem (&ConfigData
->DhcpServer
, &OptionList
[Index
]->Data
[2], sizeof (EFI_IPv6_ADDRESS
));
327 if (BootFileOpt
== NULL
) {
328 Status
= EFI_UNSUPPORTED
;
333 // Get iSCSI root path from Boot File Uniform Resource Locator (URL) Option
335 Status
= IScsiDhcp6ExtractRootPath (
336 (CHAR8
*) BootFileOpt
->Data
,
343 FreePool (OptionList
);
349 Parse the DHCP ACK to get the address configuration and DNS information.
351 @param[in] Image The handle of the driver image.
352 @param[in] Controller The handle of the controller;
353 @param[in, out] ConfigData The attempt configuration data.
355 @retval EFI_SUCCESS The DNS information is got from the DHCP ACK.
356 @retval EFI_NO_MAPPING DHCP failed to acquire address and other
358 @retval EFI_INVALID_PARAMETER The DHCP ACK's DNS option is malformatted.
359 @retval EFI_DEVICE_ERROR Some unexpected error occurred.
360 @retval EFI_OUT_OF_RESOURCES There is no sufficient resource to finish the
362 @retval EFI_NO_MEDIA There was a media error.
368 IN EFI_HANDLE Controller
,
369 IN OUT ISCSI_ATTEMPT_CONFIG_NVDATA
*ConfigData
372 EFI_HANDLE Dhcp6Handle
;
373 EFI_DHCP6_PROTOCOL
*Dhcp6
;
375 EFI_STATUS TimerStatus
;
376 EFI_DHCP6_PACKET_OPTION
*Oro
;
377 EFI_DHCP6_RETRANSMISSION InfoReqReXmit
;
379 BOOLEAN MediaPresent
;
382 // Check media status before doing DHCP.
385 NetLibDetectMedia (Controller
, &MediaPresent
);
391 // iSCSI will only request target info from DHCPv6 server.
393 if (!ConfigData
->SessionConfigData
.TargetInfoFromDhcp
) {
403 // Create a DHCP6 child instance and get the protocol.
405 Status
= NetLibCreateServiceChild (
408 &gEfiDhcp6ServiceBindingProtocolGuid
,
411 if (EFI_ERROR (Status
)) {
415 Status
= gBS
->OpenProtocol (
417 &gEfiDhcp6ProtocolGuid
,
421 EFI_OPEN_PROTOCOL_BY_DRIVER
423 if (EFI_ERROR (Status
)) {
427 Oro
= AllocateZeroPool (sizeof (EFI_DHCP6_PACKET_OPTION
) + 5);
429 Status
= EFI_OUT_OF_RESOURCES
;
434 // Ask the server to reply with DNS and Boot File URL options by info request.
435 // All members in EFI_DHCP6_PACKET_OPTION are in network order.
437 Oro
->OpCode
= HTONS (DHCP6_OPT_REQUEST_OPTION
);
438 Oro
->OpLen
= HTONS (2 * 3);
439 Oro
->Data
[1] = DHCP6_OPT_DNS_SERVERS
;
440 Oro
->Data
[3] = DHCP6_OPT_BOOT_FILE_URL
;
441 Oro
->Data
[5] = DHCP6_OPT_BOOT_FILE_PARA
;
443 InfoReqReXmit
.Irt
= 4;
444 InfoReqReXmit
.Mrc
= 1;
445 InfoReqReXmit
.Mrt
= 10;
446 InfoReqReXmit
.Mrd
= 30;
448 Status
= Dhcp6
->InfoRequest (
456 IScsiDhcp6ParseReply
,
459 if (Status
== EFI_NO_MAPPING
) {
460 Status
= gBS
->CreateEvent (EVT_TIMER
, TPL_CALLBACK
, NULL
, NULL
, &Timer
);
461 if (EFI_ERROR (Status
)) {
465 Status
= gBS
->SetTimer (
468 ISCSI_GET_MAPPING_TIMEOUT
471 if (EFI_ERROR (Status
)) {
477 TimerStatus
= gBS
->CheckEvent (Timer
);
479 if (!EFI_ERROR (TimerStatus
)) {
480 Status
= Dhcp6
->InfoRequest (
488 IScsiDhcp6ParseReply
,
493 } while (TimerStatus
== EFI_NOT_READY
);
504 gBS
->CloseEvent (Timer
);
510 &gEfiDhcp6ProtocolGuid
,
516 NetLibDestroyServiceChild (
519 &gEfiDhcp6ServiceBindingProtocolGuid
,