+++ /dev/null
-/** @file\r
- Translate the DataHub records via EFI_DATA_HUB_PROTOCOL to Smbios recorders \r
- via EFI_SMBIOS_PROTOCOL.\r
- \r
-Copyright (c) 2009 - 2015, 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
-\r
-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
-**/\r
-\r
-#include "Thunk.h"\r
-\r
-EFI_SMBIOS_PROTOCOL *mSmbiosProtocol = NULL;\r
-\r
-/**\r
- Release the structure Node. \r
- \r
- @param StructureNode Point to SMBIOS_STRUCTURE_NODE which will be removed.\r
-**/\r
-VOID\r
-ReleaseStructureNode (\r
- SMBIOS_STRUCTURE_NODE *StructureNode\r
- )\r
-{\r
- EFI_SMBIOS_PROTOCOL *Smbios;\r
- \r
- RemoveEntryList (&(StructureNode->Link));\r
- Smbios = GetSmbiosProtocol();\r
- ASSERT (Smbios != NULL);\r
- Smbios->Remove (Smbios, StructureNode->SmbiosHandle);\r
- gBS->FreePool (StructureNode);\r
-}\r
-\r
-/**\r
- Process a datahub's record and find corresponding translation way to translate\r
- to SMBIOS record.\r
- \r
- @param Record Point to datahub record.\r
-**/\r
-VOID\r
-SmbiosProcessDataRecord (\r
- IN EFI_DATA_RECORD_HEADER *Record\r
- )\r
-{\r
- EFI_DATA_RECORD_HEADER *RecordHeader;\r
- EFI_SUBCLASS_TYPE1_HEADER *DataHeader;\r
- UINTN Index;\r
- SMBIOS_CONVERSION_TABLE_ENTRY *Conversion;\r
- UINT8 *SrcData;\r
- UINTN SrcDataSize;\r
- LIST_ENTRY *Link;\r
- SMBIOS_STRUCTURE_NODE *StructureNode;\r
- BOOLEAN StructureCreated;\r
- EFI_STATUS Status;\r
- \r
- Conversion = NULL;\r
- StructureNode = NULL;\r
- StructureCreated = FALSE;\r
- RecordHeader = Record;\r
- DataHeader = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);\r
- SrcData = (UINT8 *) (DataHeader + 1);\r
- SrcDataSize = RecordHeader->RecordSize - RecordHeader->HeaderSize - sizeof (EFI_SUBCLASS_TYPE1_HEADER);\r
-\r
- if (DataHeader->HeaderSize != sizeof (EFI_SUBCLASS_TYPE1_HEADER) ||\r
- DataHeader->Instance == EFI_SUBCLASS_INSTANCE_RESERVED ||\r
- DataHeader->SubInstance == EFI_SUBCLASS_INSTANCE_RESERVED\r
- ) {\r
- //\r
- // Invalid Data Record\r
- //\r
- goto Done;\r
- }\r
-\r
- Index = 0;\r
- while(TRUE) {\r
- //\r
- // Find a matching entry in the conversion table for this\r
- // (SubClass, RecordNumber) pair\r
- //\r
- for (; !CompareGuid (&(mConversionTable[Index].SubClass), &gZeroGuid); Index++) {\r
- if (CompareGuid (\r
- &(mConversionTable[Index].SubClass),\r
- &(RecordHeader->DataRecordGuid)\r
- )) {\r
- if (mConversionTable[Index].RecordType == DataHeader->RecordType) {\r
- break;\r
- }\r
- }\r
- }\r
-\r
- if (CompareGuid (&(mConversionTable[Index].SubClass), &gZeroGuid)) {\r
- //\r
- // We cannot find a matching entry in conversion table,\r
- // this means this data record cannot be used for SMBIOS.\r
- // Just skip it.\r
- //\r
- goto Done;\r
- }\r
-\r
- Conversion = &mConversionTable[Index++];\r
-\r
- //\r
- // Find corresponding structure in the Structure List\r
- //\r
- for (Link = mStructureList.ForwardLink; Link != &mStructureList; Link = Link->ForwardLink) {\r
-\r
- StructureNode = CR (\r
- Link,\r
- SMBIOS_STRUCTURE_NODE,\r
- Link,\r
- SMBIOS_STRUCTURE_NODE_SIGNATURE\r
- );\r
-\r
- if (Conversion->StructureLocatingMethod == BySubclassInstanceSubinstanceProducer) {\r
- //\r
- // Look at SubClass, Instance, SubInstance and ProducerName for a matching\r
- // node\r
- //\r
- if (CompareGuid (&(StructureNode->SubClass), &(RecordHeader->DataRecordGuid)) &&\r
- StructureNode->Instance == DataHeader->Instance &&\r
- StructureNode->SubInstance == DataHeader->SubInstance &&\r
- CompareGuid (&(StructureNode->ProducerName), &(RecordHeader->ProducerName))\r
- ) {\r
- if (Conversion->SmbiosType >= 0x80) {\r
- if (StructureNode->SmbiosType == ((SMBIOS_STRUCTURE_HDR *) SrcData)->Type) {\r
- break;\r
- }\r
- } else if (StructureNode->SmbiosType == Conversion->SmbiosType) {\r
- break;\r
- }\r
- }\r
-\r
- } else if (Conversion->StructureLocatingMethod == BySubClassInstanceProducer) {\r
- //\r
- // Look at SubClass, Instance and ProducerName for a matching node\r
- //\r
- if (CompareGuid (&(StructureNode->SubClass), &(RecordHeader->DataRecordGuid)) &&\r
- StructureNode->Instance == DataHeader->Instance &&\r
- CompareGuid (&(StructureNode->ProducerName), &(RecordHeader->ProducerName))\r
- ) {\r
- if (Conversion->SmbiosType >= 0x80) {\r
- if (StructureNode->SmbiosType == ((SMBIOS_STRUCTURE_HDR *) SrcData)->Type) {\r
- break;\r
- }\r
- } else if (StructureNode->SmbiosType == Conversion->SmbiosType) {\r
- break;\r
- }\r
- }\r
-\r
- } else {\r
- //\r
- // Invalid conversion table entry\r
- //\r
- goto Done;\r
- }\r
- }\r
-\r
- if (Link == &mStructureList || StructureNode == NULL) {\r
-\r
- //\r
- // Not found, create a new structure\r
- //\r
- StructureNode = AllocateZeroPool (sizeof (SMBIOS_STRUCTURE_NODE));\r
-\r
- if (StructureNode == NULL) {\r
- goto Done;\r
- }\r
-\r
- if (Conversion->StructureLocatingMethod == BySubclassInstanceSubinstanceProducer) {\r
- //\r
- // Fill in SubClass, Instance, SubInstance and ProducerName\r
- //\r
- CopyMem (&(StructureNode->SubClass), &(RecordHeader->DataRecordGuid), sizeof (EFI_GUID));\r
- StructureNode->Instance = DataHeader->Instance;\r
- StructureNode->SubInstance = DataHeader->SubInstance;\r
- CopyMem (&(StructureNode->ProducerName), &(RecordHeader->ProducerName), sizeof (EFI_GUID));\r
-\r
- } else if (Conversion->StructureLocatingMethod == BySubClassInstanceProducer) {\r
- //\r
- // Fill in at SubClass, Instance and ProducerName, mark SubInstance as Non\r
- // Applicable\r
- //\r
- CopyMem (&(StructureNode->SubClass), &(RecordHeader->DataRecordGuid), sizeof (EFI_GUID));\r
- StructureNode->Instance = DataHeader->Instance;\r
- StructureNode->SubInstance = EFI_SUBCLASS_INSTANCE_NON_APPLICABLE;\r
- CopyMem (&(StructureNode->ProducerName), &(RecordHeader->ProducerName), sizeof (EFI_GUID));\r
-\r
- }\r
- //\r
- // Allocate the structure instance\r
- //\r
- StructureNode->StructureSize = SmbiosGetTypeMinimalLength (Conversion->SmbiosType);\r
- \r
- //\r
- // StructureSize include the TWO trailing zero byte.\r
- //\r
- if (StructureNode->StructureSize < (sizeof(SMBIOS_STRUCTURE) + 2)) {\r
- //\r
- // Invalid Type\r
- //\r
- gBS->FreePool (StructureNode);\r
- goto Done;\r
- }\r
-\r
- //\r
- // Assign correct SmbiosType when OEM type and Non-OEM type\r
- //\r
- if (Conversion->SmbiosType >= 0x80) {\r
- StructureNode->SmbiosType = ((SMBIOS_STRUCTURE_HDR *) SrcData)->Type;\r
- } else {\r
- StructureNode->SmbiosType = Conversion->SmbiosType;\r
- }\r
- \r
- StructureNode->SmbiosHandle = SMBIOS_HANDLE_PI_RESERVED;\r
- Status = SmbiosProtocolCreateRecord (\r
- NULL, \r
- StructureNode\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto Done;\r
- }\r
- //\r
- // Temporary cache the structrue pointer to Smbios database.\r
- //\r
- StructureNode->Structure = GetSmbiosBufferFromHandle (StructureNode->SmbiosHandle, StructureNode->SmbiosType, NULL);\r
- \r
- InitializeListHead (&StructureNode->LinkDataFixup);\r
-\r
- //\r
- // Insert the Structure Node into the Strucutre List\r
- //\r
- StructureNode->Signature = SMBIOS_STRUCTURE_NODE_SIGNATURE;\r
- InsertTailList (&mStructureList, &(StructureNode->Link));\r
-\r
- StructureCreated = TRUE;\r
-\r
- }\r
- \r
- \r
- //\r
- // Re-calculate the structure pointer to Smbios database.\r
- //\r
- StructureNode->Structure = GetSmbiosBufferFromHandle (StructureNode->SmbiosHandle, StructureNode->SmbiosType, NULL);\r
- \r
- //\r
- // Fill the Structure's field corresponding to this data record\r
- //\r
- if (Conversion->FieldFillingMethod == RecordDataUnchangedOffsetSpecified) {\r
- //\r
- // Field data is just the record data without transforming and\r
- // offset is specified directly in the conversion table entry\r
- //\r
- if (Conversion->FieldOffset + SrcDataSize > StructureNode->Structure->Length) {\r
- //\r
- // Invalid Conversion Table Entry\r
- //\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
- \r
- CopyMem ((UINT8 *) (StructureNode->Structure) + Conversion->FieldOffset, SrcData, SrcDataSize);\r
-\r
- } else if (Conversion->FieldFillingMethod == ByFunctionWithOffsetSpecified) {\r
- //\r
- // Field offfset is specified in the conversion table entry, but\r
- // record data needs to be transformed to be filled into the field,\r
- // so let the FieldFillingFunction do it.\r
- //\r
- if (Conversion->FieldFillingFunction == NULL) {\r
- //\r
- // Invalid Conversion Table Entry\r
- //\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
-\r
- Status = Conversion->FieldFillingFunction (\r
- StructureNode,\r
- Conversion->FieldOffset,\r
- SrcData,\r
- (UINT32) SrcDataSize\r
- );\r
- if (EFI_ERROR (Status)) {\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
- } else if (Conversion->FieldFillingMethod == ByFunction) {\r
- //\r
- // Both field offset and field content are determined by\r
- // FieldFillingFunction\r
- //\r
- if (Conversion->FieldFillingFunction == NULL) {\r
- //\r
- // Invalid Conversion Table Entry\r
- //\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
-\r
- Status = Conversion->FieldFillingFunction (\r
- StructureNode,\r
- 0,\r
- SrcData,\r
- (UINT32) SrcDataSize\r
- );\r
- if (EFI_ERROR (Status)) {\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
- } else if (Conversion->FieldFillingMethod == ByFunctionWithWholeDataRecord) {\r
- //\r
- // Both field offset and field content are determined by\r
- // FieldFillingFunction and the function accepts the whole data record\r
- // including the data header\r
- //\r
- if (Conversion->FieldFillingFunction == NULL) {\r
- //\r
- // Invalid Conversion Table Entry\r
- //\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
-\r
- Status = Conversion->FieldFillingFunction (\r
- StructureNode,\r
- 0,\r
- DataHeader,\r
- RecordHeader->RecordSize - RecordHeader->HeaderSize\r
- );\r
- if (EFI_ERROR (Status)) {\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
- } else {\r
- //\r
- // Invalid Conversion Table Entry\r
- //\r
- if (StructureCreated) {\r
- ReleaseStructureNode (StructureNode);\r
- }\r
-\r
- goto Done;\r
- }\r
- \r
- //\r
- // SmbiosEnlargeStructureBuffer is called to remove and add again\r
- // this SMBIOS entry to reflash SMBIOS table in configuration table.\r
- //\r
- SmbiosEnlargeStructureBuffer (\r
- StructureNode,\r
- StructureNode->Structure->Length,\r
- StructureNode->StructureSize,\r
- StructureNode->StructureSize\r
- );\r
- }\r
-Done:\r
- return ;\r
-}\r
-\r
-/**\r
- Calculate the minimal length for a SMBIOS type. This length maybe not equal\r
- to sizeof (SMBIOS_RECORD_STRUCTURE), but defined in conformance chapter in SMBIOS specification.\r
- \r
- @param Type SMBIOS's type.\r
- \r
- @return the minimal length of a smbios record.\r
-**/\r
-UINT32\r
-SmbiosGetTypeMinimalLength (\r
- IN UINT8 Type\r
- )\r
-{\r
- UINTN Index;\r
-\r
- for (Index = 0; mTypeInfoTable[Index].MinLength != 0; Index++) {\r
- if (mTypeInfoTable[Index].Type == Type) {\r
- return mTypeInfoTable[Index].MinLength;\r
- }\r
- }\r
-\r
- return 0;\r
-}\r
-\r
-/**\r
- Get pointer of EFI_SMBIOS_PROTOCOL.\r
- \r
- @return pointer of EFI_SMBIOS_PROTOCOL.\r
-**/\r
-EFI_SMBIOS_PROTOCOL*\r
-GetSmbiosProtocol(\r
- VOID\r
- )\r
-{\r
- EFI_STATUS Status;\r
- \r
- if (mSmbiosProtocol == NULL) {\r
- Status = gBS->LocateProtocol (&gEfiSmbiosProtocolGuid, NULL, (VOID*) &mSmbiosProtocol);\r
- ASSERT_EFI_ERROR (Status);\r
- } \r
- \r
- ASSERT (mSmbiosProtocol != NULL);\r
- return mSmbiosProtocol; \r
-} \r
-\r
-/**\r
- Create a blank smbios record. The datahub record is only a field of smbios record.\r
- So before fill any field from datahub's record. A blank smbios record need to be \r
- created.\r
- \r
- @param ProducerHandle The produce handle for a datahub record\r
- @param StructureNode Point to SMBIOS_STRUCTURE_NODE\r
- \r
- @retval EFI_OUT_OF_RESOURCES Fail to allocate memory for new blank SMBIOS record.\r
- @retval EFI_SUCCESS Success to create blank smbios record.\r
-**/\r
-EFI_STATUS\r
-SmbiosProtocolCreateRecord (\r
- IN EFI_HANDLE ProducerHandle, OPTIONAL\r
- IN SMBIOS_STRUCTURE_NODE *StructureNode\r
- )\r
-{\r
- EFI_SMBIOS_PROTOCOL *Smbios;\r
- EFI_SMBIOS_TABLE_HEADER *BlankRecord;\r
- EFI_STATUS Status;\r
- SMBIOS_STRUCTURE_NODE *RefStructureNode;\r
- LIST_ENTRY *Link;\r
- LIST_ENTRY *Link1;\r
- LIST_ENTRY *Link2; \r
- SMBIOS_LINK_DATA_FIXUP_NODE *LinkDataFixupNode;\r
- UINT8 *BufferPointer;\r
- \r
- Smbios = GetSmbiosProtocol();\r
- ASSERT (Smbios != NULL);\r
- \r
- //\r
- // Prepare a blank smbios record.\r
- //\r
- BlankRecord = (EFI_SMBIOS_TABLE_HEADER*) AllocateZeroPool (StructureNode->StructureSize);\r
- if (BlankRecord == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- BlankRecord->Type = StructureNode->SmbiosType;\r
- BlankRecord->Length = (UINT8) (StructureNode->StructureSize - 2);\r
- \r
- //\r
- // Add blank record into SMBIOS database.\r
- //\r
- Status = Smbios->Add (Smbios, NULL, &StructureNode->SmbiosHandle, BlankRecord);\r
- FreePool (BlankRecord);\r
- \r
- //\r
- // Fix up the InterLink node for new added smbios record if some other\r
- // existing smbios record want to link this new record's handle.\r
- //\r
- for (Link = mStructureList.ForwardLink; Link != &mStructureList; Link = Link->ForwardLink) {\r
- RefStructureNode = CR (Link, SMBIOS_STRUCTURE_NODE, Link, SMBIOS_STRUCTURE_NODE_SIGNATURE);\r
- for (Link1 = RefStructureNode->LinkDataFixup.ForwardLink; Link1 != &RefStructureNode->LinkDataFixup;) {\r
- LinkDataFixupNode = CR (Link1, SMBIOS_LINK_DATA_FIXUP_NODE, Link, SMBIOS_LINK_DATA_FIXUP_NODE_SIGNATURE);\r
- Link2 = Link1;\r
- Link1 = Link1->ForwardLink;\r
- \r
- if ((StructureNode->SmbiosType != LinkDataFixupNode->TargetType) ||\r
- !(CompareGuid (&StructureNode->SubClass, &LinkDataFixupNode->SubClass)) ||\r
- (StructureNode->Instance != LinkDataFixupNode->LinkData.Instance) ||\r
- (StructureNode->SubInstance != LinkDataFixupNode->LinkData.SubInstance)) {\r
- continue;\r
- }\r
- \r
- //\r
- // Fill the field with the handle found\r
- //\r
- BufferPointer = (UINT8 *) (RefStructureNode->Structure) + LinkDataFixupNode->Offset;\r
- *BufferPointer = (UINT8) (StructureNode->SmbiosHandle & 0xFF);\r
- *(BufferPointer + 1) = (UINT8) ((StructureNode->SmbiosHandle >> 8) & 0xFF);\r
- BufferPointer = NULL;\r
-\r
- RemoveEntryList (Link2);\r
- FreePool (LinkDataFixupNode);\r
- }\r
- }\r
- \r
- return Status;\r
-} \r
-\r
-/**\r
- Get pointer of a SMBIOS record's buffer according to its handle.\r
- \r
- @param Handle The handle of SMBIOS record want to be searched.\r
- @param Type The type of SMBIOS record want to be searched.\r
- @param ProducerHandle The producer handle of SMBIOS record.\r
- \r
- @return EFI_SMBIOS_TABLE_HEADER Point to a SMBIOS record's buffer.\r
-**/ \r
-EFI_SMBIOS_TABLE_HEADER*\r
-GetSmbiosBufferFromHandle (\r
- IN EFI_SMBIOS_HANDLE Handle,\r
- IN EFI_SMBIOS_TYPE Type,\r
- IN EFI_HANDLE ProducerHandle OPTIONAL\r
- )\r
-{\r
- EFI_SMBIOS_PROTOCOL* Smbios;\r
- EFI_SMBIOS_HANDLE SearchingHandle;\r
- EFI_SMBIOS_TABLE_HEADER *RecordInSmbiosDatabase;\r
- EFI_STATUS Status;\r
- \r
- SearchingHandle = SMBIOS_HANDLE_PI_RESERVED;\r
- Smbios = GetSmbiosProtocol();\r
- ASSERT (Smbios != NULL);\r
- \r
- do {\r
- Status = Smbios->GetNext (Smbios, &SearchingHandle, &Type, &RecordInSmbiosDatabase, NULL);\r
- } while ((SearchingHandle != Handle) && (Status != EFI_NOT_FOUND));\r
- \r
- return RecordInSmbiosDatabase;\r
-} \r
-\r
-/**\r
-\r
- Get the full size of smbios structure including optional strings that follow the formatted structure.\r
-\r
- @param Head Pointer to the beginning of smbios structure.\r
- @param Size The returned size.\r
- @param NumberOfStrings The returned number of optional strings that follow the formatted structure.\r
-\r
- @retval EFI_SUCCESS Size retured in Size.\r
- @retval EFI_INVALID_PARAMETER Input smbios structure mal-formed or Size is NULL.\r
- \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-GetSmbiosStructureSize (\r
- IN EFI_SMBIOS_TABLE_HEADER *Head,\r
- OUT UINT32 *Size,\r
- OUT UINT8 *NumberOfStrings\r
- )\r
-{\r
- UINT32 FullSize;\r
- UINT8 StrLen;\r
- INT8* CharInStr;\r
- \r
- if (Size == NULL || NumberOfStrings == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- FullSize = Head->Length;\r
- CharInStr = (INT8*)Head + Head->Length;\r
- *Size = FullSize;\r
- *NumberOfStrings = 0;\r
- StrLen = 0;\r
- //\r
- // look for the two consecutive zeros, check the string limit by the way.\r
- //\r
- while (*CharInStr != 0 || *(CharInStr+1) != 0) { \r
- if (*CharInStr == 0) {\r
- *Size += 1;\r
- CharInStr++;\r
- }\r
-\r
- for (StrLen = 0 ; StrLen < SMBIOS_STRING_MAX_LENGTH; StrLen++) {\r
- if (*(CharInStr+StrLen) == 0) {\r
- break;\r
- } \r
- }\r
-\r
- if (StrLen == SMBIOS_STRING_MAX_LENGTH) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
- //\r
- // forward the pointer\r
- //\r
- CharInStr += StrLen;\r
- *Size += StrLen;\r
- *NumberOfStrings += 1;\r
- \r
- }\r
-\r
- //\r
- // count ending two zeros.\r
- //\r
- *Size += 2;\r
- return EFI_SUCCESS; \r
-}\r