Add IPV6 support from UNDI

Add new information block ‘IPV6 support from UNDI’ in AIP protocol and provide sample implementation in UNDI driver.
Update PXE driver to get ‘Ipv6Available’ of PXE BC Mode data from UNDI driver, if unsupported then not to start PXE over IPv6 path. 


Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ye Ting <ting.ye@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Wu Jiaxin <jiaxin.wu@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17275 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 263 insertions, 2 deletions

diff --git a/OptionRomPkg/UndiRuntimeDxe/Init.c b/OptionRomPkg/UndiRuntimeDxe/Init.c
index 4e4327005f..41892ca2b6 100644
--- a/OptionRomPkg/UndiRuntimeDxe/Init.c
+++ b/OptionRomPkg/UndiRuntimeDxe/Init.c
@@ -435,7 +435,7 @@ UndiDriverStart (
   UNDI32Device->NIIProtocol_31.MinorVer       = PXE_ROMID_MINORVER_31;

   UNDI32Device->NIIProtocol_31.ImageSize      = 0;

   UNDI32Device->NIIProtocol_31.ImageAddr      = 0;

-  UNDI32Device->NIIProtocol_31.Ipv6Supported  = FALSE;

+  UNDI32Device->NIIProtocol_31.Ipv6Supported  = TRUE;

 

   UNDI32Device->NIIProtocol_31.StringId[0]    = 'U';

   UNDI32Device->NIIProtocol_31.StringId[1]    = 'N';

@@ -444,6 +444,10 @@ UndiDriverStart (
 

   UNDI32Device->DeviceHandle                  = NULL;

 

+  UNDI32Device->Aip.GetInformation            = UndiAipGetInfo;

+  UNDI32Device->Aip.SetInformation            = UndiAipSetInfo;

+  UNDI32Device->Aip.GetSupportedTypes         = UndiAipGetSupportedTypes;

+

   //

   // install both the 3.0 and 3.1 NII protocols.

   //

@@ -453,6 +457,8 @@ UndiDriverStart (
                   &UNDI32Device->NIIProtocol_31,

                   &gEfiDevicePathProtocolGuid,

                   UNDI32Device->Undi32DevPath,

+                  &gEfiAdapterInformationProtocolGuid,

+                  &UNDI32Device->Aip,

                   NULL

                   );

 

@@ -497,6 +503,8 @@ UndiErrorAllocDataPointer:
                   &UNDI32Device->NIIProtocol_31,

                   &gEfiDevicePathProtocolGuid,

                   UNDI32Device->Undi32DevPath,

+                  &gEfiAdapterInformationProtocolGuid,

+                  &UNDI32Device->Aip,

                   NULL

                   );

 

diff --git a/OptionRomPkg/UndiRuntimeDxe/Undi32.h b/OptionRomPkg/UndiRuntimeDxe/Undi32.h
index d09761d59d..18341dd512 100644
--- a/OptionRomPkg/UndiRuntimeDxe/Undi32.h
+++ b/OptionRomPkg/UndiRuntimeDxe/Undi32.h
@@ -21,6 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/PciIo.h>

 #include <Protocol/NetworkInterfaceIdentifier.h>

 #include <Protocol/DevicePath.h>

+#include <Protocol/AdapterInformation.h>

 

 #include <Library/UefiDriverEntryPoint.h>

 #include <Library/UefiRuntimeLib.h>

@@ -30,6 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiLib.h>

 #include <Library/BaseLib.h>

 #include <Library/DevicePathLib.h>

+#include <Library/MemoryAllocationLib.h>

 

 #include <IndustryStandard/Pci.h>

 

@@ -57,10 +59,12 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gUndiComponentName2;
 #define UNDI_DEV_SIGNATURE   SIGNATURE_32('u','n','d','i')

 #define UNDI_DEV_FROM_THIS(a) CR(a, UNDI32_DEV, NIIProtocol_31, UNDI_DEV_SIGNATURE)

 #define UNDI_DEV_FROM_NIC(a) CR(a, UNDI32_DEV, NicInfo, UNDI_DEV_SIGNATURE)

+#define UNDI_DEV_FROM_AIP(a) CR(a, UNDI32_DEV, Aip, UNDI_DEV_SIGNATURE)

 

 typedef struct {

   UINTN                                     Signature;

   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol_31;

+  EFI_ADAPTER_INFORMATION_PROTOCOL          Aip;

   EFI_HANDLE                                DeviceHandle;

   EFI_DEVICE_PATH_PROTOCOL                  *Undi32BaseDevPath;

   EFI_DEVICE_PATH_PROTOCOL                  *Undi32DevPath;

@@ -343,4 +347,99 @@ INT32 validate_mcip (PXE_MAC_ADDR *MCastAddr);
 VOID PxeStructInit (PXE_SW_UNDI *PxePtr);

 VOID PxeUpdate (NIC_DATA_INSTANCE *NicPtr, PXE_SW_UNDI *PxePtr);

 

+//

+// functions defined in UndiAipImpl.c

+//

+

+/**

+  Returns the current state information for the adapter.

+

+  This function returns information of type InformationType from the adapter.

+  If an adapter does not support the requested informational type, then

+  EFI_UNSUPPORTED is returned. 

+

+  @param[in]  This                   A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.

+  @param[in]  InformationType        A pointer to an EFI_GUID that defines the contents of InformationBlock.

+  @param[out] InforamtionBlock       The service returns a pointer to the buffer with the InformationBlock

+                                     structure which contains details about the data specific to InformationType.

+  @param[out] InforamtionBlockSize   The driver returns the size of the InformationBlock in bytes.

+

+  @retval EFI_SUCCESS                The InformationType information was retrieved.

+  @retval EFI_UNSUPPORTED            The InformationType is not known.

+  @retval EFI_DEVICE_ERROR           The device reported an error.

+  @retval EFI_OUT_OF_RESOURCES       The request could not be completed due to a lack of resources.

+  @retval EFI_INVALID_PARAMETER      This is NULL. 

+  @retval EFI_INVALID_PARAMETER      InformationBlock is NULL. 

+  @retval EFI_INVALID_PARAMETER      InformationBlockSize is NULL.

+

+**/  

+EFI_STATUS

+EFIAPI

+UndiAipGetInfo (

+  IN   EFI_ADAPTER_INFORMATION_PROTOCOL *This,

+  IN   EFI_GUID                         *InformationType,

+  OUT  VOID                             **InformationBlock,

+  OUT  UINTN                            *InformationBlockSize

+  );

+

+/**

+  Sets state information for an adapter.

+

+  This function sends information of type InformationType for an adapter.

+  If an adapter does not support the requested information type, then EFI_UNSUPPORTED

+  is returned.

+

+  @param[in]  This                   A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.

+  @param[in]  InformationType        A pointer to an EFI_GUID that defines the contents of InformationBlock.

+  @param[in]  InforamtionBlock       A pointer to the InformationBlock structure which contains details

+                                     about the data specific to InformationType.

+  @param[in]  InforamtionBlockSize   The size of the InformationBlock in bytes.

+

+  @retval EFI_SUCCESS                The information was received and interpreted successfully.

+  @retval EFI_UNSUPPORTED            The InformationType is not known.

+  @retval EFI_DEVICE_ERROR           The device reported an error.

+  @retval EFI_INVALID_PARAMETER      This is NULL.

+  @retval EFI_INVALID_PARAMETER      InformationBlock is NULL.

+  @retval EFI_WRITE_PROTECTED        The InformationType cannot be modified using EFI_ADAPTER_INFO_SET_INFO().

+

+**/                        

+EFI_STATUS

+EFIAPI

+UndiAipSetInfo (

+  IN   EFI_ADAPTER_INFORMATION_PROTOCOL *This,

+  IN   EFI_GUID                         *InformationType,

+  IN   VOID                             *InformationBlock,

+  IN   UINTN                            InformationBlockSize

+  );

+

+/**

+  Get a list of supported information types for this instance of the protocol.

+

+  This function returns a list of InformationType GUIDs that are supported on an

+  adapter with this instance of EFI_ADAPTER_INFORMATION_PROTOCOL. The list is returned

+  in InfoTypesBuffer, and the number of GUID pointers in InfoTypesBuffer is returned in

+  InfoTypesBufferCount.

+

+  @param[in]  This                  A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.

+  @param[out] InfoTypesBuffer       A pointer to the list of InformationType GUID pointers that are supported

+                                    by This.

+  @param[out] InfoTypesBufferCount  A pointer to the number of GUID pointers present in InfoTypesBuffer.

+

+  @retval EFI_SUCCESS               The list of information type GUIDs that are supported on this adapter was

+                                    returned in InfoTypesBuffer. The number of information type GUIDs was

+                                    returned in InfoTypesBufferCount.

+  @retval EFI_INVALID_PARAMETER     This is NULL.

+  @retval EFI_INVALID_PARAMETER     InfoTypesBuffer is NULL.

+  @retval EFI_INVALID_PARAMETER     InfoTypesBufferCount is NULL.

+  @retval EFI_OUT_OF_RESOURCES      There is not enough pool memory to store the results.

+

+**/                        

+EFI_STATUS

+EFIAPI

+UndiAipGetSupportedTypes (

+  IN    EFI_ADAPTER_INFORMATION_PROTOCOL *This,

+  OUT   EFI_GUID                         **InfoTypesBuffer,

+  OUT   UINTN                            *InfoTypesBufferCount

+  );

+

 #endif

diff --git a/OptionRomPkg/UndiRuntimeDxe/UndiAipImpl.c b/OptionRomPkg/UndiRuntimeDxe/UndiAipImpl.c
new file mode 100644
index 0000000000..17552a1929
--- /dev/null
+++ b/OptionRomPkg/UndiRuntimeDxe/UndiAipImpl.c
@@ -0,0 +1,151 @@
+/** @file

+

+Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>

+This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+**/

+

+

+#include "Undi32.h"

+

+

+UINTN      mSupportedInfoTypesCount = 1;

+EFI_GUID   mSupportedInfoTypes[] = {

+  EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT_GUID

+};

+

+/**

+  Returns the current state information for the adapter.

+

+  This function returns information of type InformationType from the adapter.

+  If an adapter does not support the requested informational type, then

+  EFI_UNSUPPORTED is returned. 

+

+  @param[in]  This                   A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.

+  @param[in]  InformationType        A pointer to an EFI_GUID that defines the contents of InformationBlock.

+  @param[out] InforamtionBlock       The service returns a pointer to the buffer with the InformationBlock

+                                     structure which contains details about the data specific to InformationType.

+  @param[out] InforamtionBlockSize   The driver returns the size of the InformationBlock in bytes.

+

+  @retval EFI_SUCCESS                The InformationType information was retrieved.

+  @retval EFI_UNSUPPORTED            The InformationType is not known.

+  @retval EFI_DEVICE_ERROR           The device reported an error.

+  @retval EFI_OUT_OF_RESOURCES       The request could not be completed due to a lack of resources.

+  @retval EFI_INVALID_PARAMETER      This is NULL. 

+  @retval EFI_INVALID_PARAMETER      InformationBlock is NULL. 

+  @retval EFI_INVALID_PARAMETER      InformationBlockSize is NULL.

+

+**/  

+EFI_STATUS

+EFIAPI

+UndiAipGetInfo (

+  IN   EFI_ADAPTER_INFORMATION_PROTOCOL *This,

+  IN   EFI_GUID                         *InformationType,

+  OUT  VOID                             **InformationBlock,

+  OUT  UINTN                            *InformationBlockSize

+  )

+{

+  UNDI32_DEV                            *UNDI32Device;

+  EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT    *UndiIpv6Support;

+

+  if (This == NULL || InformationBlock == NULL || InformationBlockSize == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  if (!CompareGuid (InformationType, &gEfiAdapterInfoUndiIpv6SupportGuid)) {

+    return EFI_UNSUPPORTED;

+  }

+

+  UNDI32Device = UNDI_DEV_FROM_AIP (This);

+  *InformationBlockSize = sizeof (EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT);

+  *InformationBlock = AllocateZeroPool (*InformationBlockSize);

+  if (*InformationBlock == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  UndiIpv6Support = (EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT *) (*InformationBlock);

+  UndiIpv6Support->Ipv6Support = UNDI32Device->NIIProtocol_31.Ipv6Supported;

+

+  return EFI_SUCCESS;

+}

+

+/**

+  Sets state information for an adapter.

+

+  This function sends information of type InformationType for an adapter.

+  If an adapter does not support the requested information type, then EFI_UNSUPPORTED

+  is returned.

+

+  @param[in]  This                   A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.

+  @param[in]  InformationType        A pointer to an EFI_GUID that defines the contents of InformationBlock.

+  @param[in]  InforamtionBlock       A pointer to the InformationBlock structure which contains details

+                                     about the data specific to InformationType.

+  @param[in]  InforamtionBlockSize   The size of the InformationBlock in bytes.

+

+  @retval EFI_SUCCESS                The information was received and interpreted successfully.

+  @retval EFI_UNSUPPORTED            The InformationType is not known.

+  @retval EFI_DEVICE_ERROR           The device reported an error.

+  @retval EFI_INVALID_PARAMETER      This is NULL.

+  @retval EFI_INVALID_PARAMETER      InformationBlock is NULL.

+  @retval EFI_WRITE_PROTECTED        The InformationType cannot be modified using EFI_ADAPTER_INFO_SET_INFO().

+

+**/                        

+EFI_STATUS

+EFIAPI

+UndiAipSetInfo (

+  IN   EFI_ADAPTER_INFORMATION_PROTOCOL *This,

+  IN   EFI_GUID                         *InformationType,

+  IN   VOID                             *InformationBlock,

+  IN   UINTN                            InformationBlockSize

+  )

+{

+  return EFI_WRITE_PROTECTED;

+}

+

+/**

+  Get a list of supported information types for this instance of the protocol.

+

+  This function returns a list of InformationType GUIDs that are supported on an

+  adapter with this instance of EFI_ADAPTER_INFORMATION_PROTOCOL. The list is returned

+  in InfoTypesBuffer, and the number of GUID pointers in InfoTypesBuffer is returned in

+  InfoTypesBufferCount.

+

+  @param[in]  This                  A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.

+  @param[out] InfoTypesBuffer       A pointer to the list of InformationType GUID pointers that are supported

+                                    by This.

+  @param[out] InfoTypesBufferCount  A pointer to the number of GUID pointers present in InfoTypesBuffer.

+

+  @retval EFI_SUCCESS               The list of information type GUIDs that are supported on this adapter was

+                                    returned in InfoTypesBuffer. The number of information type GUIDs was

+                                    returned in InfoTypesBufferCount.

+  @retval EFI_INVALID_PARAMETER     This is NULL.

+  @retval EFI_INVALID_PARAMETER     InfoTypesBuffer is NULL.

+  @retval EFI_INVALID_PARAMETER     InfoTypesBufferCount is NULL.

+  @retval EFI_OUT_OF_RESOURCES      There is not enough pool memory to store the results.

+

+**/                        

+EFI_STATUS

+EFIAPI

+UndiAipGetSupportedTypes (

+  IN    EFI_ADAPTER_INFORMATION_PROTOCOL *This,

+  OUT   EFI_GUID                         **InfoTypesBuffer,

+  OUT   UINTN                            *InfoTypesBufferCount

+  )

+{

+  if (This == NULL || InfoTypesBuffer == NULL || InfoTypesBufferCount == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  *InfoTypesBufferCount = 1;

+  *InfoTypesBuffer = AllocateCopyPool (sizeof (EFI_GUID), &gEfiAdapterInfoUndiIpv6SupportGuid);

+  if (InfoTypesBuffer == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  return EFI_SUCCESS;

+}

diff --git a/OptionRomPkg/UndiRuntimeDxe/UndiRuntimeDxe.inf b/OptionRomPkg/UndiRuntimeDxe/UndiRuntimeDxe.inf
index 4be7044be7..b07c04e2cf 100644
--- a/OptionRomPkg/UndiRuntimeDxe/UndiRuntimeDxe.inf
+++ b/OptionRomPkg/UndiRuntimeDxe/UndiRuntimeDxe.inf
@@ -36,11 +36,11 @@
   Decode.c

   Init.c

   ComponentName.c

+  UndiAipImpl.c

 

 [Packages]

   MdePkg/MdePkg.dec

 

-

 [LibraryClasses]

   UefiLib

   UefiBootServicesTableLib

@@ -49,15 +49,18 @@
   UefiRuntimeLib

   UefiDriverEntryPoint

   BaseLib

+  MemoryAllocationLib

 

 [Protocols]

   gEfiNetworkInterfaceIdentifierProtocolGuid_31

   gEfiPciIoProtocolGuid

   gEfiDevicePathProtocolGuid

+  gEfiAdapterInformationProtocolGuid

 

 [Guids]

   gEfiEventExitBootServicesGuid        ## PRODUCES ## Event

   gEfiEventVirtualAddressChangeGuid    ## PRODUCES ## Event

+  gEfiAdapterInfoUndiIpv6SupportGuid   ## PRODUCES

 

 [Depex]

   gEfiBdsArchProtocolGuid AND