summaryrefslogtreecommitdiffstats
path: root/ArmPkg/Universal/Smbios/SmbiosMiscDxe/Type02/MiscBaseBoardManufacturerFunction.c
blob: 3441e7798860db68883bfd119ed619bddf8127b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/** @file
  This driver parses the mSmbiosMiscDataTable structure and reports
  any generated data using SMBIOS protocol.

  Based on files under Nt32Pkg/MiscSubClassPlatformDxe/

  Copyright (c) 2022, Ampere Computing LLC. All rights reserved.<BR>
  Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>
  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
  Copyright (c) 2015, Hisilicon Limited. All rights reserved.<BR>
  Copyright (c) 2015, Linaro Limited. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/HiiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/OemMiscLib.h>
#include <Library/PrintLib.h>
#include <Library/UefiBootServicesTableLib.h>

#include "SmbiosMisc.h"

/**
  This function makes boot time changes to the contents of the
  MiscBaseBoardManufacturer (Type 2) record.

  @param  RecordData                 Pointer to SMBIOS table with default values.
  @param  Smbios                     SMBIOS protocol.

  @retval EFI_SUCCESS                The SMBIOS table was successfully added.
  @retval EFI_INVALID_PARAMETER      Invalid parameter was found.
  @retval EFI_OUT_OF_RESOURCES       Failed to allocate required memory.

**/
SMBIOS_MISC_TABLE_FUNCTION (MiscBaseBoardManufacturer) {
  CHAR8               *OptionalStrStart;
  CHAR8               *StrStart;
  UINTN               RecordLength;
  UINTN               ManuStrLen;
  UINTN               ProductNameStrLen;
  UINTN               VerStrLen;
  UINTN               SerialNumStrLen;
  UINTN               AssetTagStrLen;
  UINTN               ChassisLocaStrLen;
  UINTN               HandleCount;
  UINT16              *HandleArray;
  CHAR16              *BaseBoardManufacturer;
  CHAR16              *BaseBoardProductName;
  CHAR16              *Version;
  EFI_STRING          SerialNumber;
  EFI_STRING          AssetTag;
  EFI_STRING          ChassisLocation;
  EFI_STRING_ID       TokenToGet;
  SMBIOS_TABLE_TYPE2  *SmbiosRecord;
  SMBIOS_TABLE_TYPE2  *InputData;
  EFI_STATUS          Status;

  EFI_STRING_ID  TokenToUpdate;

  HandleCount = 0;
  HandleArray = NULL;
  InputData   = NULL;

  //
  // First check for invalid parameters.
  //
  if (RecordData == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  InputData = (SMBIOS_TABLE_TYPE2 *)RecordData;

  BaseBoardManufacturer = (CHAR16 *)PcdGetPtr (PcdBaseBoardManufacturer);
  if (StrLen (BaseBoardManufacturer) > 0) {
    TokenToUpdate = STRING_TOKEN (STR_MISC_BASE_BOARD_MANUFACTURER);
    HiiSetString (mSmbiosMiscHiiHandle, TokenToUpdate, BaseBoardManufacturer, NULL);
  } else {
    OemUpdateSmbiosInfo (
      mSmbiosMiscHiiHandle,
      STRING_TOKEN (STR_MISC_BASE_BOARD_MANUFACTURER),
      BoardManufacturerType02
      );
  }

  BaseBoardProductName = (CHAR16 *)PcdGetPtr (PcdBaseBoardProductName);
  if (StrLen (BaseBoardProductName) > 0) {
    TokenToUpdate = STRING_TOKEN (STR_MISC_BASE_BOARD_PRODUCT_NAME);
    HiiSetString (mSmbiosMiscHiiHandle, TokenToUpdate, BaseBoardProductName, NULL);
  } else {
    OemUpdateSmbiosInfo (
      mSmbiosMiscHiiHandle,
      STRING_TOKEN (STR_MISC_BASE_BOARD_PRODUCT_NAME),
      ProductNameType02
      );
  }

  Version = (CHAR16 *)PcdGetPtr (PcdBaseBoardVersion);
  if (StrLen (Version) > 0) {
    TokenToUpdate = STRING_TOKEN (STR_MISC_BASE_BOARD_VERSION);
    HiiSetString (mSmbiosMiscHiiHandle, TokenToUpdate, Version, NULL);
  } else {
    OemUpdateSmbiosInfo (
      mSmbiosMiscHiiHandle,
      STRING_TOKEN (STR_MISC_BASE_BOARD_VERSION),
      VersionType02
      );
  }

  OemUpdateSmbiosInfo (
    mSmbiosMiscHiiHandle,
    STRING_TOKEN (STR_MISC_BASE_BOARD_ASSET_TAG),
    AssetTagType02
    );
  OemUpdateSmbiosInfo (
    mSmbiosMiscHiiHandle,
    STRING_TOKEN (STR_MISC_BASE_BOARD_SERIAL_NUMBER),
    SerialNumberType02
    );
  OemUpdateSmbiosInfo (
    mSmbiosMiscHiiHandle,
    STRING_TOKEN (STR_MISC_BASE_BOARD_SKU_NUMBER),
    SerialNumberType02
    );
  OemUpdateSmbiosInfo (
    mSmbiosMiscHiiHandle,
    STRING_TOKEN (STR_MISC_BASE_BOARD_CHASSIS_LOCATION),
    ChassisLocationType02
    );

  TokenToGet            = STRING_TOKEN (STR_MISC_BASE_BOARD_MANUFACTURER);
  BaseBoardManufacturer = HiiGetPackageString (&gEfiCallerIdGuid, TokenToGet, NULL);
  ManuStrLen            = StrLen (BaseBoardManufacturer);

  TokenToGet           = STRING_TOKEN (STR_MISC_BASE_BOARD_PRODUCT_NAME);
  BaseBoardProductName = HiiGetPackageString (&gEfiCallerIdGuid, TokenToGet, NULL);
  ProductNameStrLen    = StrLen (BaseBoardProductName);

  TokenToGet = STRING_TOKEN (STR_MISC_BASE_BOARD_VERSION);
  Version    = HiiGetPackageString (&gEfiCallerIdGuid, TokenToGet, NULL);
  VerStrLen  = StrLen (Version);

  TokenToGet      = STRING_TOKEN (STR_MISC_BASE_BOARD_SERIAL_NUMBER);
  SerialNumber    = HiiGetPackageString (&gEfiCallerIdGuid, TokenToGet, NULL);
  SerialNumStrLen = StrLen (SerialNumber);

  TokenToGet     = STRING_TOKEN (STR_MISC_BASE_BOARD_ASSET_TAG);
  AssetTag       = HiiGetPackageString (&gEfiCallerIdGuid, TokenToGet, NULL);
  AssetTagStrLen = StrLen (AssetTag);

  TokenToGet        = STRING_TOKEN (STR_MISC_BASE_BOARD_CHASSIS_LOCATION);
  ChassisLocation   = HiiGetPackageString (&gEfiCallerIdGuid, TokenToGet, NULL);
  ChassisLocaStrLen = StrLen (ChassisLocation);

  //
  // Two zeros following the last string.
  //
  RecordLength = sizeof (SMBIOS_TABLE_TYPE2) +
                 ManuStrLen        + 1 +
                 ProductNameStrLen + 1 +
                 VerStrLen         + 1 +
                 SerialNumStrLen   + 1 +
                 AssetTagStrLen    + 1 +
                 ChassisLocaStrLen + 1 + 1;
  SmbiosRecord = AllocateZeroPool (RecordLength);
  if (SmbiosRecord == NULL) {
    Status = EFI_OUT_OF_RESOURCES;
    goto Exit;
  }

  (VOID)CopyMem (SmbiosRecord, InputData, sizeof (SMBIOS_TABLE_TYPE2));
  SmbiosRecord->Hdr.Length = sizeof (SMBIOS_TABLE_TYPE2);

  //
  //  Update Contained objects Handle
  //
  SmbiosRecord->NumberOfContainedObjectHandles = 0;
  SmbiosMiscGetLinkTypeHandle (
    EFI_SMBIOS_TYPE_SYSTEM_ENCLOSURE,
    &HandleArray,
    &HandleCount
    );
  // It's assumed there's at most a single chassis
  ASSERT (HandleCount < 2);
  if (HandleCount > 0) {
    SmbiosRecord->ChassisHandle = HandleArray[0];
  }

  FreePool (HandleArray);

  OptionalStrStart = (CHAR8 *)(SmbiosRecord + 1);
  UnicodeStrToAsciiStrS (BaseBoardManufacturer, OptionalStrStart, ManuStrLen + 1);

  StrStart = OptionalStrStart + ManuStrLen + 1;
  UnicodeStrToAsciiStrS (BaseBoardProductName, StrStart, ProductNameStrLen + 1);

  StrStart += ProductNameStrLen + 1;
  UnicodeStrToAsciiStrS (Version, StrStart, VerStrLen + 1);

  StrStart += VerStrLen + 1;
  UnicodeStrToAsciiStrS (SerialNumber, StrStart, SerialNumStrLen + 1);

  StrStart += SerialNumStrLen + 1;
  UnicodeStrToAsciiStrS (AssetTag, StrStart, AssetTagStrLen + 1);

  StrStart += AssetTagStrLen + 1;
  UnicodeStrToAsciiStrS (ChassisLocation, StrStart, ChassisLocaStrLen + 1);

  Status = SmbiosMiscAddRecord ((UINT8 *)SmbiosRecord, NULL);
  if (EFI_ERROR (Status)) {
    DEBUG ((
      DEBUG_ERROR,
      "[%a]:[%dL] Smbios Type02 Table Log Failed! %r \n",
      __FUNCTION__,
      DEBUG_LINE_NUMBER,
      Status
      ));
  }

  FreePool (SmbiosRecord);

Exit:
  if (BaseBoardManufacturer != NULL) {
    FreePool (BaseBoardManufacturer);
  }

  if (BaseBoardProductName != NULL) {
    FreePool (BaseBoardProductName);
  }

  if (Version != NULL) {
    FreePool (Version);
  }

  if (SerialNumber != NULL) {
    FreePool (SerialNumber);
  }

  if (AssetTag != NULL) {
    FreePool (AssetTag);
  }

  if (ChassisLocation != NULL) {
    FreePool (ChassisLocation);
  }

  return 0;
}