EmulatorPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmulatorPkg / MiscSubClassPlatformDxe / MiscPortInternalConnectorDesignatorFunction.c

/*++\r
\r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
Module Name:\r
\r
  MiscPortInternalConnectorDesignatorFunction.c\r
\r
Abstract:\r
\r
  This driver parses the mMiscSubclassDataTable structure and reports\r
  any generated data to the DataHub.\r
\r
**/\r
\r
#include "MiscSubClassDriver.h"\r
\r
\r
MISC_SMBIOS_TABLE_FUNCTION (\r
  MiscPortInternalConnectorDesignator\r
  )\r
/*++\r
Description:\r
\r
  This function makes boot time changes to the contents of the\r
  MiscPortConnectorInformation (Type 8).\r
\r
Parameters:\r
\r
  RecordType\r
    Type of record to be processed from the Data Table.\r
    mMiscSubclassDataTable[].RecordType\r
\r
  RecordLen\r
    Size of static RecordData from the Data Table.\r
    mMiscSubclassDataTable[].RecordLen\r
\r
  RecordData\r
    Pointer to copy of RecordData from the Data Table.  Changes made\r
    to this copy will be written to the Data Hub but will not alter\r
    the contents of the static Data Table.\r
\r
  LogRecordData\r
    Set *LogRecordData to TRUE to log RecordData to Data Hub.\r
    Set *LogRecordData to FALSE when there is no more data to log.\r
\r
Returns:\r
\r
  EFI_SUCCESS\r
    All parameters were valid and *RecordData and *LogRecordData have\r
    been set.\r
\r
  EFI_UNSUPPORTED\r
    Unexpected RecordType value.\r
\r
  EFI_INVALID_PARAMETER\r
    One of the following parameter conditions was true:\r
      RecordLen was zero.\r
      RecordData was NULL.\r
      LogRecordData was NULL.\r
**/\r
{\r
  CHAR8                                        *OptionalStrStart;\r
  UINTN                                        InternalRefStrLen;\r
  UINTN                                        ExternalRefStrLen;\r
  EFI_STRING                                   InternalRef;\r
  EFI_STRING                                   ExternalRef;\r
  STRING_REF                                   TokenForInternal;\r
  STRING_REF                                   TokenForExternal;\r
  EFI_STATUS                                   Status;\r
  SMBIOS_TABLE_TYPE8                           *SmbiosRecord;\r
  EFI_SMBIOS_HANDLE                            SmbiosHandle;\r
  EFI_MISC_PORT_INTERNAL_CONNECTOR_DESIGNATOR  *ForType8InputData;\r
\r
  ForType8InputData = (EFI_MISC_PORT_INTERNAL_CONNECTOR_DESIGNATOR *)RecordData;\r
  //\r
  // First check for invalid parameters.\r
  //\r
  if (RecordData == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  TokenForInternal = 0;\r
  TokenForExternal = 0;\r
\r
  switch (ForType8InputData->PortInternalConnectorDesignator) {\r
\r
    case STR_MISC_PORT_INTERNAL_CONNECTOR_DESIGNATOR:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_CONNECTOR_DESIGNATOR);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_CONNECTOR_DESIGNATOR);\r
      break;\r
    case STR_MISC_PORT_INTERNAL_KEYBOARD:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_KEYBOARD);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_KEYBOARD);\r
      break;\r
    case STR_MISC_PORT_INTERNAL_MOUSE:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_MOUSE);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_MOUSE);\r
      break;\r
    case STR_MISC_PORT_INTERNAL_COM1:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_COM1);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_COM1);\r
      break;\r
    case STR_MISC_PORT_INTERNAL_COM2:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_COM2);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_COM2);\r
      break;\r
    case STR_MISC_PORT_INTERNAL_EXTENSION_POWER:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_EXTENSION_POWER);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_EXTENSION_POWER);\r
      break;\r
    case STR_MISC_PORT_INTERNAL_FLOPPY:\r
      TokenForInternal = STRING_TOKEN (STR_MISC_PORT_INTERNAL_FLOPPY);\r
      TokenForExternal = STRING_TOKEN(STR_MISC_PORT_EXTERNAL_FLOPPY);\r
      break;\r
    default:\r
      break;\r
  }\r
\r
  InternalRef = HiiGetPackageString(&gEfiCallerIdGuid, TokenForInternal, NULL);\r
  InternalRefStrLen = StrLen(InternalRef);\r
  if (InternalRefStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  ExternalRef = HiiGetPackageString(&gEfiCallerIdGuid, TokenForExternal, NULL);\r
  ExternalRefStrLen = StrLen(ExternalRef);\r
  if (ExternalRefStrLen > SMBIOS_STRING_MAX_LENGTH) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Two zeros following the last string.\r
  //\r
  SmbiosRecord = AllocatePool(sizeof (SMBIOS_TABLE_TYPE8) + InternalRefStrLen + 1 + ExternalRefStrLen + 1 + 1);\r
  ZeroMem(SmbiosRecord, sizeof (SMBIOS_TABLE_TYPE8) + InternalRefStrLen + 1 + ExternalRefStrLen + 1 + 1);\r
\r
  SmbiosRecord->Hdr.Type = EFI_SMBIOS_TYPE_PORT_CONNECTOR_INFORMATION;\r
  SmbiosRecord->Hdr.Length = sizeof (SMBIOS_TABLE_TYPE8);\r
  //\r
  // Make handle chosen by smbios protocol.add automatically.\r
  //\r
  SmbiosRecord->Hdr.Handle = 0;\r
  SmbiosRecord->InternalReferenceDesignator = 1;\r
  SmbiosRecord->InternalConnectorType = (UINT8)ForType8InputData->PortInternalConnectorType;\r
  SmbiosRecord->ExternalReferenceDesignator = 2;\r
  SmbiosRecord->ExternalConnectorType = (UINT8)ForType8InputData->PortExternalConnectorType;\r
  SmbiosRecord->PortType = (UINT8)ForType8InputData->PortType;\r
\r
  OptionalStrStart = (CHAR8 *)(SmbiosRecord + 1);\r
  UnicodeStrToAsciiStr(InternalRef, OptionalStrStart);\r
  UnicodeStrToAsciiStr(ExternalRef, OptionalStrStart + InternalRefStrLen + 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
\r
\r
\r
/* eof - MiscSystemManufacturerFunction.c */\r