Vlv2TbltDevicePkg/SmBiosMiscDxe/MiscOnboardDeviceFunction.c

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