Vlv2TbltDevicePkg/SmBiosMiscDxe/MiscOnboardDeviceFunction.c

   1 /** @file
   2
   3 Copyright (c) 1999  - 2014, Intel Corporation. All rights reserved.<BR>
   4
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7
   8
   9
  10 Module Name:
  11
  12   MiscOnboardDeviceFunction.c
  13
  14 Abstract:
  15
  16   Create the device path for the Onboard device.
  17   The Onboard device information is Misc. subclass type 8 and SMBIOS type 10.
  18
  19
  20 **/
  21
  22
  23 #include "CommonHeader.h"
  24
  25 #include "MiscSubclassDriver.h"
  26
  27
  28
  29 /**
  30   This is a macro defined function, in fact, the function is
  31   MiscOnboardDeviceFunction (RecordType, RecordLen, RecordData, LogRecordData)
  32   This function makes boot time changes to the contents of the
  33   MiscOnboardDevice structure.
  34
  35   @param  MiscOnboardDevice      The string which is used to create the function
  36   The Arguments in fact:
  37   @param  RecordType             Type of record to be processed from the Data
  38                                  Table. mMiscSubclassDataTable[].RecordType
  39   @param  RecordLen              Size of static RecordData from the Data Table.
  40                                  mMiscSubclassDataTable[].RecordLen
  41   @param  RecordData             Pointer to RecordData, which will be written to
  42                                  the Data Hub
  43   @param  LogRecordData          TRUE to log RecordData to Data Hub. FALSE when
  44                                  there is no more data to log.
  45
  46   @retval EFI_SUCCESS            *RecordData and *LogRecordData have been set.
  47   @retval EFI_UNSUPPORTED        Unexpected RecordType value.
  48   @retval EFI_INVALID_PARAMETER  One of the following parameter conditions was
  49                                  true: RecordLen was zero. RecordData was NULL.
  50                                  LogRecordData was NULL.
  51
  52 **/
  53 MISC_SMBIOS_TABLE_FUNCTION (
  54   MiscOnboardDevice
  55   )
  56 {
  57   CHAR8                         *OptionalStrStart;
  58   UINT8                         StatusAndType;
  59   UINTN                         DescriptionStrLen;
  60   EFI_STRING                    DeviceDescription;
  61   STRING_REF                    TokenToGet;
  62   EFI_STATUS                    Status;
  63   EFI_SMBIOS_HANDLE             SmbiosHandle;
  64   SMBIOS_TABLE_TYPE10           *SmbiosRecord;
  65   EFI_MISC_ONBOARD_DEVICE       *ForType10InputData;
  66
  67   ForType10InputData = (EFI_MISC_ONBOARD_DEVICE *)RecordData;
  68
  69   //
  70   // First check for invalid parameters.
  71   //
  72   if (RecordData == NULL) {
  73     return EFI_INVALID_PARAMETER;
  74   }
  75
  76   TokenToGet = 0;
  77   switch (ForType10InputData->OnBoardDeviceDescription) {
  78     case STR_MISC_ONBOARD_DEVICE_VIDEO:
  79       TokenToGet = STRING_TOKEN (STR_MISC_ONBOARD_DEVICE_VIDEO);
  80       break;
  81     case STR_MISC_ONBOARD_DEVICE_AUDIO:
  82       TokenToGet = STRING_TOKEN (STR_MISC_ONBOARD_DEVICE_AUDIO);
  83       break;
  84         default:
  85         break;
  86   }
  87
  88   DeviceDescription = SmbiosMiscGetString (TokenToGet);
  89   DescriptionStrLen = StrLen(DeviceDescription);
  90   if (DescriptionStrLen > SMBIOS_STRING_MAX_LENGTH) {
  91     return EFI_UNSUPPORTED;
  92   }
  93
  94   //
  95   // Two zeros following the last string.
  96   //
  97   SmbiosRecord = AllocatePool(sizeof (SMBIOS_TABLE_TYPE10) + DescriptionStrLen + 1 + 1);
  98   ZeroMem(SmbiosRecord, sizeof (SMBIOS_TABLE_TYPE10) + DescriptionStrLen + 1 + 1);
  99
 100   SmbiosRecord->Hdr.Type = EFI_SMBIOS_TYPE_ONBOARD_DEVICE_INFORMATION;
 101   SmbiosRecord->Hdr.Length = sizeof (SMBIOS_TABLE_TYPE10);
 102
 103   //
 104   // Make handle chosen by smbios protocol.add automatically.
 105   //
 106   SmbiosRecord->Hdr.Handle = 0;
 107
 108   //
 109   // Status & Type: Bit 7 Devicen Status, Bits 6:0 Type of Device
 110   //
 111   StatusAndType = (UINT8) ForType10InputData->OnBoardDeviceStatus.DeviceType;
 112   if (ForType10InputData->OnBoardDeviceStatus.DeviceEnabled != 0) {
 113     StatusAndType |= 0x80;
 114   } else {
 115     StatusAndType &= 0x7F;
 116   }
 117
 118   SmbiosRecord->Device[0].DeviceType = StatusAndType;
 119   SmbiosRecord->Device[0].DescriptionString = 1;
 120   OptionalStrStart = (CHAR8 *)(SmbiosRecord + 1);
 121   UnicodeStrToAsciiStr(DeviceDescription, OptionalStrStart);
 122
 123   //
 124   // Now we have got the full smbios record, call smbios protocol to add this record.
 125   //
 126   SmbiosHandle = SMBIOS_HANDLE_PI_RESERVED;
 127   Status = Smbios-> Add(
 128                       Smbios,
 129                       NULL,
 130                       &SmbiosHandle,
 131                       (EFI_SMBIOS_TABLE_HEADER *) SmbiosRecord
 132                       );
 133   FreePool(SmbiosRecord);
 134   return Status;
 135 }