Nt32Pkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Nt32Pkg / MiscSubClassPlatformDxe / MiscChassisManufacturerFunction.c

/** @file\r
  Chassis manufacturer information boot time changes.\r
  SMBIOS type 3.\r
  \r
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2017 Hewlett Packard Enterprise Development LP<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "MiscSubclassDriver.h"\r
\r
/**\r
  This function makes boot time changes to the contents of the\r
  MiscChassisManufacturer (Type 3).\r
\r
  @param  RecordData                 Pointer to copy of RecordData from the Data Table.  \r
\r
  @retval EFI_SUCCESS                All parameters were valid.\r
  @retval EFI_UNSUPPORTED            Unexpected RecordType value.\r
  @retval EFI_INVALID_PARAMETER      Invalid parameter was found.\r
\r
**/\r
MISC_SMBIOS_TABLE_FUNCTION(MiscChassisManufacturer)\r
{\r
  CHAR8                           *OptionalStrStart;\r
  UINTN                           ManuStrLen;\r
  UINTN                           VerStrLen;\r
  UINTN                           AssetTagStrLen;\r
  UINTN                           SerialNumStrLen;\r
  UINTN                           SkuNumberStrLen;\r
  EFI_STATUS                      Status;\r
  EFI_STRING                      Manufacturer;\r
  EFI_STRING                      Version;\r
  EFI_STRING                      SerialNumber;\r
  EFI_STRING                      AssetTag;\r
  EFI_STRING                      SkuNumber;\r
  STRING_REF                      TokenToGet;\r
  EFI_SMBIOS_HANDLE               SmbiosHandle;\r
  SMBIOS_TABLE_TYPE3              *SmbiosRecord;\r
  EFI_MISC_CHASSIS_MANUFACTURER   *ForType3InputData;\r
  UINT8                           *Buffer;\r
\r
  ForType3InputData = (EFI_MISC_CHASSIS_MANUFACTURER *)RecordData;\r
\r
  //\r
  // First check for invalid parameters.\r
  //\r
  if (RecordData == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  TokenToGet = STRING_TOKEN (STR_MISC_CHASSIS_MANUFACTURER);\r
  Manufacturer = HiiGetPackageString(&gEfiCallerIdGuid, TokenToGet, NULL);\r
  ManuStrLen = StrLen(Manufacturer);\r
  if (ManuStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  TokenToGet = STRING_TOKEN (STR_MISC_CHASSIS_VERSION);\r
  Version = HiiGetPackageString(&gEfiCallerIdGuid, TokenToGet, NULL);\r
  VerStrLen = StrLen(Version);\r
  if (VerStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  TokenToGet = STRING_TOKEN (STR_MISC_CHASSIS_SERIAL_NUMBER);\r
  SerialNumber = HiiGetPackageString(&gEfiCallerIdGuid, TokenToGet, NULL);\r
  SerialNumStrLen = StrLen(SerialNumber);\r
  if (SerialNumStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  TokenToGet = STRING_TOKEN (STR_MISC_CHASSIS_ASSET_TAG);\r
  AssetTag = HiiGetPackageString(&gEfiCallerIdGuid, TokenToGet, NULL);\r
  AssetTagStrLen = StrLen(AssetTag);\r
  if (AssetTagStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  TokenToGet = STRING_TOKEN (STR_MISC_CHASSIS_SKU_NUMBER);\r
  SkuNumber = HiiGetPackageString(&gEfiCallerIdGuid, TokenToGet, NULL);\r
  SkuNumberStrLen = StrLen(SkuNumber);\r
  if (SkuNumberStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Two zeros following the last string.\r
  //\r
  // Since we set ContainedElementCount = 0 and ContainedElementRecordLength = 0,\r
  // remove sizeof (CONTAINED_ELEMENT) for ContainedElements[1].\r
  //\r
  // Add sizeof (SMBIOS_TABLE_STRING) for SKU Number, since not contained in SMBIOS_TABLE_TYPE3.\r
  //\r
  SmbiosRecord = AllocatePool(sizeof (SMBIOS_TABLE_TYPE3) - sizeof (CONTAINED_ELEMENT) + sizeof (SMBIOS_TABLE_STRING) + ManuStrLen + 1 + VerStrLen + 1 + SerialNumStrLen + 1 + AssetTagStrLen + 1 + SkuNumberStrLen + 1 + 1);\r
  ZeroMem(SmbiosRecord, sizeof (SMBIOS_TABLE_TYPE3) - sizeof (CONTAINED_ELEMENT) + sizeof (SMBIOS_TABLE_STRING) + ManuStrLen + 1  + VerStrLen + 1 + SerialNumStrLen + 1 + AssetTagStrLen + 1 + SkuNumberStrLen + 1 + 1);\r
\r
  Buffer = (UINT8 *) SmbiosRecord;\r
\r
  SmbiosRecord->Hdr.Type = EFI_SMBIOS_TYPE_SYSTEM_ENCLOSURE;\r
  //\r
  // Since we set ContainedElementCount = 0 and ContainedElementRecordLength = 0,\r
  // remove sizeof (CONTAINED_ELEMENT) for ContainedElements[1].\r
  //\r
  // Add sizeof (SMBIOS_TABLE_STRING) for SKU Number, since not contained in SMBIOS_TABLE_TYPE3.\r
  //\r
  SmbiosRecord->Hdr.Length = sizeof (SMBIOS_TABLE_TYPE3) - sizeof (CONTAINED_ELEMENT) + sizeof (SMBIOS_TABLE_STRING);\r
  //\r
  // Make handle chosen by smbios protocol.add automatically.\r
  //\r
  SmbiosRecord->Hdr.Handle = 0;  \r
  //\r
  // Manu will be the 1st optional string following the formatted structure.\r
  // \r
  SmbiosRecord->Manufacturer = 1;  \r
  SmbiosRecord->Type = (UINT8)ForType3InputData->ChassisType.ChassisType;\r
  //\r
  // Version will be the 2nd optional string following the formatted structure.\r
  //\r
  SmbiosRecord->Version = 2;  \r
  //\r
  // SerialNumber will be the 3rd optional string following the formatted structure.\r
  //\r
  SmbiosRecord->SerialNumber = 3;  \r
  //\r
  // AssetTag will be the 4th optional string following the formatted structure.\r
  //\r
  SmbiosRecord->AssetTag = 4;\r
\r
  SmbiosRecord->BootupState = (UINT8)ForType3InputData->ChassisBootupState;\r
  SmbiosRecord->PowerSupplyState = (UINT8)ForType3InputData->ChassisPowerSupplyState;\r
  SmbiosRecord->ThermalState = (UINT8)ForType3InputData->ChassisThermalState;\r
  SmbiosRecord->SecurityStatus = (UINT8)ForType3InputData->ChassisSecurityState;\r
  CopyMem (SmbiosRecord->OemDefined,(UINT8*)&ForType3InputData->ChassisOemDefined, 4);\r
  SmbiosRecord->Height = (UINT8)ForType3InputData->ChassisHeight;\r
  SmbiosRecord->NumberofPowerCords = (UINT8)ForType3InputData->ChassisNumberPowerCords;\r
  SmbiosRecord->ContainedElementCount = 0;\r
  SmbiosRecord->ContainedElementRecordLength = 0;\r
\r
  //\r
  // SKU Number will be the 5th optional string following the formatted structure.\r
  //\r
  // Since SKU Number is not in SMBIOS_TABLE_TYPE3 structure, must locate it after ContainedElementRecordLength.\r
  //\r
  Buffer[sizeof (SMBIOS_TABLE_TYPE3) - sizeof (CONTAINED_ELEMENT)] = 5;\r
\r
  OptionalStrStart = (CHAR8 *)(SmbiosRecord + 1);\r
  //\r
  // Since we set ContainedElementCount = 0 and ContainedElementRecordLength = 0,\r
  // remove sizeof (CONTAINED_ELEMENT) for ContainedElements[1].\r
  //\r
  OptionalStrStart -= sizeof (CONTAINED_ELEMENT);\r
  //\r
  // Add sizeof (SMBIOS_TABLE_STRING) for SKU Number, since not contained in SMBIOS_TABLE_TYPE3.\r
  //\r
  OptionalStrStart += sizeof (SMBIOS_TABLE_STRING);\r
  UnicodeStrToAsciiStr (Manufacturer, OptionalStrStart);\r
  UnicodeStrToAsciiStr (Version, OptionalStrStart + ManuStrLen + 1);\r
  UnicodeStrToAsciiStr (SerialNumber, OptionalStrStart + ManuStrLen + 1 + VerStrLen + 1);\r
  UnicodeStrToAsciiStr (AssetTag, OptionalStrStart + ManuStrLen + 1 + VerStrLen + 1 + SerialNumStrLen + 1);\r
  UnicodeStrToAsciiStr (SkuNumber, OptionalStrStart + ManuStrLen + 1 + VerStrLen + 1 + SerialNumStrLen + 1 + AssetTagStrLen + 1);\r
\r
  //\r
  // Now we have got the full smbios record, call smbios protocol to add this record.\r
  //\r
  Status = AddSmbiosRecord (Smbios, &SmbiosHandle, (EFI_SMBIOS_TABLE_HEADER *) SmbiosRecord);\r
\r
  FreePool(SmbiosRecord);\r
  return Status;\r
}\r