]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
1. Add ISCSI iBFT CHAP types to IScsiBootFirmwareTable.h.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiIbft.c
index 78a1e075f080f07fbaccda56e6b5886d3390f781..372efdc15ef96ac3a56ee480241cfe9e6ec4501e 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   Implementation for iSCSI Boot Firmware Table publication.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -10,29 +10,25 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  IScsiIbft.c\r
-\r
-Abstract:\r
-\r
-  Implementation for iSCSI Boot Firmware Table publication.\r
-\r
 **/\r
 \r
 #include "IScsiImpl.h"\r
 \r
+BOOLEAN mIbftInstalled = FALSE;\r
+UINTN   mTableKey;\r
+\r
 /**\r
   Initialize the header of the iSCSI Boot Firmware Table.\r
   \r
-  @param  Header[in] The header of the iSCSI Boot Firmware Table.\r
-\r
-  @retval None.\r
-\r
+  @param[out]  Header     The header of the iSCSI Boot Firmware Table.\r
+  @param[in]   OemId      The OEM ID.\r
+  @param[in]   OemTableId The OEM table ID for the iBFT.\r
 **/\r
 VOID\r
 IScsiInitIbfTableHeader (\r
-  IN EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_HEADER  *Header\r
+  OUT EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_HEADER   *Header,\r
+  IN  UINT8                                       *OemId,\r
+  IN  UINT64                                      *OemTableId\r
   )\r
 {\r
   ZeroMem (Header, sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_HEADER));\r
@@ -41,24 +37,17 @@ IScsiInitIbfTableHeader (
   Header->Length    = IBFT_HEAP_OFFSET;\r
   Header->Revision  = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_REVISION;\r
   Header->Checksum  = 0;\r
-\r
-  Header->OemId[0]  = 'I';\r
-  Header->OemId[1]  = 'N';\r
-  Header->OemId[2]  = 'T';\r
-  Header->OemId[3]  = 'E';\r
-  Header->OemId[4]  = 'L';\r
+  \r
+  CopyMem (Header->OemId, OemId, sizeof (Header->OemId));\r
+  CopyMem (&Header->OemTableId, OemTableId, sizeof (UINT64));\r
 }\r
 \r
 /**\r
   Initialize the control section of the iSCSI Boot Firmware Table.\r
   \r
-  @param  Table[in]       The ACPI table.\r
-\r
-  @param  HandleCount[in] The number of the handles associated with iSCSI sessions, it's\r
+  @param[in]  Table       The ACPI table.\r
+  @param[in]  HandleCount The number of the handles associated with iSCSI sessions, it's\r
                           equal to the number of iSCSI sessions.\r
-\r
-  @retval None.\r
-\r
 **/\r
 VOID\r
 IScsiInitControlSection (\r
@@ -75,7 +64,7 @@ IScsiInitControlSection (
 \r
   Control->Header.StructureId = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_ID;\r
   Control->Header.Version     = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_VERSION;\r
-  Control->Header.Length      = sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE);\r
+  Control->Header.Length      = (UINT16) sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE);\r
 \r
   //\r
   // Each session occupies two offsets, one for the NIC section,\r
@@ -94,15 +83,10 @@ IScsiInitControlSection (
 /**\r
   Add one item into the heap.\r
 \r
-  @param  Heap[in][out] On input, the current address of the heap; On output, the address of\r
-                        the heap after the item is added.\r
-\r
-  @param  Data[in]      The data to add into the heap.\r
-\r
-  @param  Len[in]       Length of the Data in byte.\r
-\r
-  @retval None.\r
-\r
+  @param[in, out]  Heap  On input, the current address of the heap; On output, the address of\r
+                         the heap after the item is added.\r
+  @param[in]       Data  The data to add into the heap.\r
+  @param[in]       Len   Length of the Data in byte.\r
 **/\r
 VOID\r
 IScsiAddHeapItem (\r
@@ -123,14 +107,9 @@ IScsiAddHeapItem (
 /**\r
   Fill the Initiator section of the iSCSI Boot Firmware Table.\r
 \r
-  @param  Table[in]     The ACPI table.\r
-\r
-  @param  Heap[in][out] The heap.\r
-\r
-  @param  Handle[in]    The handle associated with the iSCSI session.\r
-\r
-  @retval None.\r
-\r
+  @param[in]       Table    The ACPI table.\r
+  @param[in, out]  Heap     The heap.\r
+  @param[in]       Handle   The handle associated with the iSCSI session.\r
 **/\r
 VOID\r
 IScsiFillInitiatorSection (\r
@@ -159,13 +138,13 @@ IScsiFillInitiatorSection (
 \r
   Initiator->Header.StructureId = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_ID;\r
   Initiator->Header.Version     = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_VERSION;\r
-  Initiator->Header.Length      = sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE);\r
+  Initiator->Header.Length      = (UINT16) sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE);\r
   Initiator->Header.Flags       = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BLOCK_VALID | EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BOOT_SELECTED;\r
 \r
   //\r
   // Get the identifier from the handle.\r
   //\r
-  Status = gBS->HandleProtocol (Handle, &mIScsiPrivateGuid, (VOID **) &IScsiIdentifier);\r
+  Status = gBS->HandleProtocol (Handle, &gEfiCallerIdGuid, (VOID **) &IScsiIdentifier);\r
   if (EFI_ERROR (Status)) {\r
     ASSERT (FALSE);\r
     return ;\r
@@ -186,12 +165,8 @@ IScsiFillInitiatorSection (
 /**\r
   Map the v4 IP address into v6 IP address.\r
 \r
-  @param  V4 The v4 IP address.\r
-\r
-  @param  V6 The v6 IP address.\r
-\r
-  @retval None.\r
-\r
+  @param[in]   V4 The v4 IP address.\r
+  @param[out]  V6 The v6 IP address.\r
 **/\r
 VOID\r
 IScsiMapV4ToV6Addr (\r
@@ -215,10 +190,10 @@ IScsiMapV4ToV6Addr (
   Get the NIC's PCI location and return it accroding to the composited\r
   format defined in iSCSI Boot Firmware Table.\r
 \r
-  @param  Controller[in]  The handle of the controller.\r
-\r
-  @retval UINT16          The composited representation of the NIC PCI location.\r
+  @param[in]  Controller  The handle of the controller.\r
 \r
+  @return UINT16          The composited representation of the NIC PCI location.\r
+  @retval 0               Other errors as indicated.\r
 **/\r
 UINT16\r
 IScsiGetNICPciLocation (\r
@@ -265,45 +240,13 @@ IScsiGetNICPciLocation (
   return (UINT16) ((Bus << 8) | (Device << 3) | Function);\r
 }\r
 \r
-/**\r
-  Get the MAC address of the controller.\r
-  \r
-  @param  Controller[in]    The handle of the controller.\r
-\r
-  @retval EFI_MAC_ADDRESS * The mac address.\r
-\r
-**/\r
-EFI_MAC_ADDRESS *\r
-IScsiGetMacAddress (\r
-  IN EFI_HANDLE  Controller\r
-  )\r
-{\r
-  EFI_STATUS                  Status;\r
-  EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
-\r
-  Status = gBS->HandleProtocol (\r
-                  Controller,\r
-                  &gEfiSimpleNetworkProtocolGuid,\r
-                  (VOID **) &Snp\r
-                  );\r
-  ASSERT_EFI_ERROR (Status);\r
-\r
-  return &Snp->Mode->PermanentAddress;\r
-}\r
-\r
 /**\r
   Fill the NIC and target sections in iSCSI Boot Firmware Table.\r
 \r
-  @param  Table[in]       The buffer of the ACPI table.\r
-\r
-  @param  Heap[in][out]   The heap buffer used to store the variable length parameters such as iSCSI name.\r
-\r
-  @param  HandleCount[in] The number of handles having iSCSI private protocol installed.\r
-\r
-  @param  Handles[in]     The handle buffer.\r
-\r
-  @retval None.\r
-\r
+  @param[in]       Table       The buffer of the ACPI table.\r
+  @param[in, out]  Heap        The heap buffer used to store the variable length parameters such as iSCSI name.\r
+  @param[in]       HandleCount Count The number of handles having iSCSI private protocol installed.\r
+  @param[in]       Handles     The handle buffer.\r
 **/\r
 VOID\r
 IScsiFillNICAndTargetSections (\r
@@ -322,7 +265,8 @@ IScsiFillNICAndTargetSections (
   UINT16                                                *SectionOffset;\r
   UINTN                                                 Index;\r
   UINT16                                                Length;\r
-  EFI_MAC_ADDRESS                                       *Mac;\r
+  EFI_MAC_ADDRESS                                       MacAddress;\r
+  UINTN                                                 HwAddressSize;\r
   ISCSI_PRIVATE_PROTOCOL                                *IScsiIdentifier;\r
   EFI_STATUS                                            Status;\r
 \r
@@ -338,7 +282,7 @@ IScsiFillNICAndTargetSections (
   SectionOffset = &Control->NIC0Offset;\r
 \r
   for (Index = 0; Index < HandleCount; Index++) {\r
-    Status = gBS->HandleProtocol (Handles[Index], &mIScsiPrivateGuid, (VOID **)&IScsiIdentifier);\r
+    Status = gBS->HandleProtocol (Handles[Index], &gEfiCallerIdGuid, (VOID **)&IScsiIdentifier);\r
     if (EFI_ERROR (Status)) {\r
       ASSERT (FALSE);\r
       return ;\r
@@ -355,7 +299,7 @@ IScsiFillNICAndTargetSections (
 \r
     Nic->Header.StructureId = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_ID;\r
     Nic->Header.Version     = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_VERSION;\r
-    Nic->Header.Length      = sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE);\r
+    Nic->Header.Length      = (UINT16) sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE);\r
     Nic->Header.Index       = (UINT8) Index;\r
     Nic->Header.Flags       = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_FLAG_BLOCK_VALID |\r
                             EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_FLAG_BOOT_SELECTED |\r
@@ -380,8 +324,11 @@ IScsiFillNICAndTargetSections (
     IScsiMapV4ToV6Addr (&SessionConfigData->SecondaryDns, &Nic->SecondaryDns);\r
     IScsiMapV4ToV6Addr (&SessionConfigData->DhcpServer, &Nic->DhcpServer);\r
 \r
-    Mac = IScsiGetMacAddress (DriverData->Controller);\r
-    CopyMem (Nic->Mac, Mac, sizeof (Nic->Mac));\r
+    Nic->VLanTag = NetLibGetVlanId (DriverData->Controller);\r
+\r
+    Status = NetLibGetMacAddress (DriverData->Controller, &MacAddress, &HwAddressSize);\r
+    ASSERT (Status == EFI_SUCCESS);\r
+    CopyMem (Nic->Mac, MacAddress.Addr, sizeof (Nic->Mac));\r
 \r
     //\r
     // Get the PCI location of the Nic.\r
@@ -398,13 +345,20 @@ IScsiFillNICAndTargetSections (
 \r
     Target->Header.StructureId  = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_ID;\r
     Target->Header.Version      = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_VERSION;\r
-    Target->Header.Length       = sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE);\r
+    Target->Header.Length       = (UINT16) sizeof (EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE);\r
     Target->Header.Index        = (UINT8) Index;\r
     Target->Header.Flags        = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_FLAG_BLOCK_VALID | EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_FLAG_BOOT_SELECTED;\r
     Target->Port                = SessionConfigData->NvData.TargetPort;\r
-    Target->CHAPType            = AuthConfig->CHAPType;\r
     Target->NicIndex            = (UINT8) Index;\r
 \r
+    if (AuthConfig->CHAPType == ISCSI_CHAP_NONE) {\r
+      Target->CHAPType = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_CHAP_TYPE_NO_CHAP;\r
+    } if (AuthConfig->CHAPType == ISCSI_CHAP_UNI) {\r
+      Target->CHAPType = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_CHAP_TYPE_CHAP;\r
+    } else if (AuthConfig->CHAPType == ISCSI_CHAP_MUTUAL) {\r
+      Target->CHAPType = EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_CHAP_TYPE_MUTUAL_CHAP;\r
+    }\r
+\r
     IScsiMapV4ToV6Addr (&SessionConfigData->NvData.TargetIp, &Target->Ip);\r
     CopyMem (Target->BootLun, SessionConfigData->NvData.BootLun, sizeof (Target->BootLun));\r
 \r
@@ -417,7 +371,7 @@ IScsiFillNICAndTargetSections (
     Target->IScsiNameLength = Length;\r
     Target->IScsiNameOffset = (UINT16) ((UINTN) *Heap - (UINTN) Table);\r
 \r
-    if (Target->CHAPType != ISCSI_CHAP_NONE) {\r
+    if (Target->CHAPType != EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_CHAP_TYPE_NO_CHAP) {\r
       //\r
       // CHAP Name\r
       //\r
@@ -434,7 +388,7 @@ IScsiFillNICAndTargetSections (
       Target->CHAPSecretLength  = Length;\r
       Target->CHAPSecretOffset  = (UINT16) ((UINTN) *Heap - (UINTN) Table);\r
 \r
-      if (Target->CHAPType == ISCSI_CHAP_MUTUAL) {\r
+      if (Target->CHAPType == EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_CHAP_TYPE_MUTUAL_CHAP) {\r
         //\r
         // Reverse CHAP Name\r
         //\r
@@ -469,74 +423,69 @@ IScsiFillNICAndTargetSections (
 /**\r
   Publish and remove the iSCSI Boot Firmware Table according to the iSCSI\r
   session status.\r
-\r
-  @param  None.\r
-\r
-  @retval None.\r
-\r
 **/\r
 VOID\r
 IScsiPublishIbft (\r
-  IN VOID\r
+  VOID\r
   )\r
 {\r
   EFI_STATUS                                Status;\r
-  UINTN                                     TableHandle;\r
-  EFI_ACPI_SUPPORT_PROTOCOL                 *AcpiSupport;\r
+  EFI_ACPI_TABLE_PROTOCOL                   *AcpiTableProtocol;\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_HEADER *Table;\r
   UINTN                                     HandleCount;\r
   EFI_HANDLE                                *HandleBuffer;\r
   UINT8                                     *Heap;\r
-  INTN                                      Index;\r
-  EFI_ACPI_TABLE_VERSION                    Version;\r
-  UINT32                                    Signature;\r
+  UINT8                                     Checksum;\r
+  UINTN                                         Index;\r
+  EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp;\r
+  EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt;\r
 \r
-  Status = gBS->LocateProtocol (&gEfiAcpiSupportProtocolGuid, NULL, (VOID **)&AcpiSupport);\r
+  Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL, (VOID **)&AcpiTableProtocol);\r
   if (EFI_ERROR (Status)) {\r
     return ;\r
   }\r
+\r
+\r
   //\r
-  // Try to remove the old iSCSI Boot Firmware Table.\r
+  // Find ACPI table RSD_PTR from system table\r
   //\r
-  for (Index = 0;; Index++) {\r
-    Status = AcpiSupport->GetAcpiTable (\r
-                            AcpiSupport,\r
-                            Index,\r
-                            (VOID **)&Table,\r
-                            &Version,\r
-                            &TableHandle\r
-                            );\r
-    if (EFI_ERROR (Status)) {\r
+  for (Index = 0, Rsdp = NULL; Index < gST->NumberOfTableEntries; Index++) {\r
+    if (CompareGuid (&(gST->ConfigurationTable[Index].VendorGuid), &gEfiAcpi20TableGuid) ||\r
+      CompareGuid (&(gST->ConfigurationTable[Index].VendorGuid), &gEfiAcpi10TableGuid) ||\r
+      CompareGuid (&(gST->ConfigurationTable[Index].VendorGuid), &gEfiAcpiTableGuid)\r
+      ) {\r
+      //\r
+      // A match was found.\r
+      //\r
+      Rsdp = (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) gST->ConfigurationTable[Index].VendorTable;\r
       break;\r
     }\r
+  }\r
 \r
-    Signature = Table->Signature;\r
-    gBS->FreePool (Table);\r
+  if (Rsdp == NULL) {\r
+    return ;\r
+  } else {\r
+    Rsdt = (EFI_ACPI_DESCRIPTION_HEADER *) (UINTN) Rsdp->RsdtAddress;\r
+  }\r
 \r
-    if (Signature == EFI_ACPI_3_0_ISCSI_BOOT_FIRMWARE_TABLE_SIGNATURE) {\r
-      //\r
-      // Remove the table.\r
-      //\r
-      Status = AcpiSupport->SetAcpiTable (\r
-                              AcpiSupport,\r
-                              NULL,\r
-                              FALSE,\r
-                              Version,\r
-                              &TableHandle\r
-                              );\r
-      if (EFI_ERROR (Status)) {\r
-        return ;\r
-      }\r
 \r
-      break;\r
+  if (mIbftInstalled) {\r
+    Status = AcpiTableProtocol->UninstallAcpiTable (\r
+                                  AcpiTableProtocol,\r
+                                  mTableKey\r
+                                  );\r
+    if (EFI_ERROR (Status)) {\r
+      return ;\r
     }\r
+    mIbftInstalled = FALSE;\r
   }\r
+\r
   //\r
   // Get all iSCSI private protocols.\r
   //\r
   Status = gBS->LocateHandleBuffer (\r
                   ByProtocol,\r
-                  &mIScsiPrivateGuid,\r
+                  &gEfiCallerIdGuid,\r
                   NULL,\r
                   &HandleCount,\r
                   &HandleBuffer\r
@@ -547,7 +496,7 @@ IScsiPublishIbft (
   //\r
   // Allocate 4k bytes to hold the ACPI table.\r
   //\r
-  Table = AllocatePool (IBFT_MAX_SIZE);\r
+  Table = AllocateZeroPool (IBFT_MAX_SIZE);\r
   if (Table == NULL) {\r
     return ;\r
   }\r
@@ -557,28 +506,29 @@ IScsiPublishIbft (
   //\r
   // Fill in the various section of the iSCSI Boot Firmware Table.\r
   //\r
-  IScsiInitIbfTableHeader (Table);\r
+  IScsiInitIbfTableHeader (Table, Rsdt->OemId, &Rsdt->OemTableId);\r
   IScsiInitControlSection (Table, HandleCount);\r
   IScsiFillInitiatorSection (Table, &Heap, HandleBuffer[0]);\r
   IScsiFillNICAndTargetSections (Table, &Heap, HandleCount, HandleBuffer);\r
 \r
-  gBS->FreePool (HandleBuffer);\r
+  Checksum = CalculateCheckSum8((UINT8 *)Table, Table->Length);\r
+  Table->Checksum = Checksum;\r
 \r
-  TableHandle = 0;\r
+  FreePool (HandleBuffer);\r
 \r
   //\r
   // Install or update the iBFT table.\r
   //\r
-  Status = AcpiSupport->SetAcpiTable (\r
-                          AcpiSupport,\r
-                          Table,\r
-                          TRUE,\r
-                          EFI_ACPI_TABLE_VERSION_3_0,\r
-                          &TableHandle\r
-                          );\r
-  if (!EFI_ERROR (Status)) {\r
-    AcpiSupport->PublishTables (AcpiSupport, EFI_ACPI_TABLE_VERSION_3_0);\r
+  Status = AcpiTableProtocol->InstallAcpiTable (\r
+                                AcpiTableProtocol,\r
+                                Table,\r
+                                Table->Length,\r
+                                &mTableKey\r
+                                );\r
+  if (EFI_ERROR(Status)) {\r
+    return;\r
   }\r
 \r
-  gBS->FreePool (Table);\r
+  mIbftInstalled = TRUE;\r
+  FreePool (Table);\r
 }\r