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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
|
/** @file
SMBIOS Table Builder.
Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include <Library/PcdLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Protocol/Smbios.h>
#include <Library/BaseMemoryLib.h>
// Module specific include files.
#include <ConfigurationManagerObject.h>
#include <ConfigurationManagerHelper.h>
#include <DeviceTreeTableGenerator.h>
#include <Library/TableHelperLib.h>
#include <Protocol/ConfigurationManagerProtocol.h>
#include <Protocol/DynamicTableFactoryProtocol.h>
#include <SmbiosTableGenerator.h>
#include <SmbiosTableDispatcher.h>
/** This macro expands to a function that retrieves the SMBIOS Table
List from the Configuration Manager.
*/
GET_OBJECT_LIST (
EObjNameSpaceStandard,
EStdObjSmbiosTableList,
CM_STD_OBJ_SMBIOS_TABLE_INFO
)
/** A helper function to build and install an SMBIOS table.
This is a helper function that invokes the Table generator interface
for building an SMBIOS table. It uses the SmbiosProtocol to install the
table, then frees the resources allocated for generating it.
@param [in] TableFactoryProtocol Pointer to the Table Factory Protocol
interface.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Generator Pointer to the SMBIOS table Generator.
@param [in] SmbiosProtocol Pointer to the SMBIOS protocol.
@param [in] SmbiosTableInfo Pointer to the SMBIOS table Info.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND Required object is not found.
@retval EFI_BAD_BUFFER_SIZE Size returned by the Configuration Manager
is less than the Object size for the
requested object.
**/
STATIC
EFI_STATUS
EFIAPI
BuildAndInstallSingleSmbiosTable (
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST TableFactoryProtocol,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator,
IN EFI_SMBIOS_PROTOCOL *SmbiosProtocol,
IN CM_STD_OBJ_SMBIOS_TABLE_INFO *CONST SmbiosTableInfo
)
{
EFI_STATUS Status;
EFI_STATUS Status1;
SMBIOS_STRUCTURE *SmbiosTable;
CM_OBJECT_TOKEN CmObjToken;
EFI_SMBIOS_HANDLE TableHandle;
SmbiosTable = NULL;
Status = Generator->BuildSmbiosTable (
Generator,
TableFactoryProtocol,
SmbiosTableInfo,
CfgMgrProtocol,
&SmbiosTable,
&CmObjToken
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Build Table." \
" TableGeneratorId = 0x%x. Status = %r\n",
SmbiosTableInfo->TableGeneratorId,
Status
));
// Free any allocated resources.
goto exit_handler;
}
if (SmbiosTable == NULL) {
Status = EFI_NOT_FOUND;
goto exit_handler;
}
TableHandle = SMBIOS_HANDLE_PI_RESERVED;
// Install SMBIOS table
Status = SmbiosProtocol->Add (
SmbiosProtocol,
NULL,
&TableHandle,
SmbiosTable
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Install SMBIOS Table. Status = %r\n",
Status
));
// Free any allocated resources.
goto exit_handler;
}
Status = TableFactoryProtocol->AddSmbiosHandle (
SmbiosProtocol,
&TableHandle,
CmObjToken,
SmbiosTableInfo->TableGeneratorId
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Add SMBIOS Handle. Status = %r\n",
Status
));
// Free any allocated resources.
goto exit_handler;
}
DEBUG ((
DEBUG_INFO,
"INFO: SMBIOS Table installed. Status = %r\n",
Status
));
exit_handler:
// Free any resources allocated for generating the tables.
if (Generator->FreeTableResources != NULL) {
Status1 = Generator->FreeTableResources (
Generator,
TableFactoryProtocol,
SmbiosTableInfo,
CfgMgrProtocol,
&SmbiosTable
);
if (EFI_ERROR (Status1)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Free Table Resources." \
"TableGeneratorId = 0x%x. Status = %r\n",
SmbiosTableInfo->TableGeneratorId,
Status1
));
}
// Return the first error status in case of failure
if (!EFI_ERROR (Status)) {
Status = Status1;
}
}
return Status;
}
/** A helper function to build and install multiple SMBIOS tables.
This is a helper function that invokes the Table generator interface
for building SMBIOS tables. It uses the SmbiosProtocol to install the
tables, then frees the resources allocated for generating it.
@param [in] TableFactoryProtocol Pointer to the Table Factory Protocol
interface.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] Generator Pointer to the SmbiosTable generator.
@param [in] SmbiosProtocol Pointer to the Smbios protocol.
@param [in] SmbiosTableInfo Pointer to the SMBIOS table Info.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND Required object is not found.
@retval EFI_BAD_BUFFER_SIZE Size returned by the Configuration Manager
is less than the Object size for the
requested object.
**/
STATIC
EFI_STATUS
EFIAPI
BuildAndInstallMultipleSmbiosTables (
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST TableFactoryProtocol,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator,
IN EFI_SMBIOS_PROTOCOL *SmbiosProtocol,
IN CM_STD_OBJ_SMBIOS_TABLE_INFO *CONST SmbiosTableInfo
)
{
EFI_STATUS Status;
EFI_STATUS Status1;
SMBIOS_STRUCTURE **SmbiosTable;
CM_OBJECT_TOKEN *CmObjToken;
EFI_SMBIOS_HANDLE TableHandle;
UINTN TableCount;
UINTN Index;
SmbiosTable = NULL;
CmObjToken = NULL;
TableCount = 0;
Status = Generator->BuildSmbiosTableEx (
Generator,
TableFactoryProtocol,
SmbiosTableInfo,
CfgMgrProtocol,
&SmbiosTable,
&CmObjToken,
&TableCount
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Build Table." \
" TableGeneratorId = 0x%x. Status = %r\n",
SmbiosTableInfo->TableGeneratorId,
Status
));
// Free any allocated resources.
goto exit_handler;
}
if ((SmbiosTable == NULL) || (TableCount == 0)) {
Status = EFI_NOT_FOUND;
DEBUG ((
DEBUG_ERROR,
"%a: TableCount %u SmbiosTable %p \n",
__func__,
TableCount,
SmbiosTable
));
goto exit_handler;
}
for (Index = 0; Index < TableCount; Index++) {
TableHandle = SMBIOS_HANDLE_PI_RESERVED;
// Install SMBIOS table
Status = SmbiosProtocol->Add (
SmbiosProtocol,
NULL,
&TableHandle,
SmbiosTable[Index]
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Install SMBIOS Table. Status = %r\n",
Status
));
// Free any allocated resources.
goto exit_handler;
}
Status = TableFactoryProtocol->AddSmbiosHandle (
SmbiosProtocol,
&TableHandle,
CmObjToken ? CmObjToken[Index] : CM_NULL_TOKEN,
SmbiosTableInfo->TableGeneratorId
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Add SMBIOS Handle. Status = %r\n",
Status
));
// Free any allocated resources.
goto exit_handler;
}
DEBUG ((
DEBUG_INFO,
"INFO: SMBIOS Table installed. Status = %r\n",
Status
));
}
exit_handler:
// Free any resources allocated for generating the tables.
if (Generator->FreeTableResourcesEx != NULL) {
Status1 = Generator->FreeTableResourcesEx (
Generator,
TableFactoryProtocol,
SmbiosTableInfo,
CfgMgrProtocol,
&SmbiosTable,
&CmObjToken,
TableCount
);
if (EFI_ERROR (Status1)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Free Table Resources." \
"TableGeneratorId = 0x%x. Status = %r\n",
SmbiosTableInfo->TableGeneratorId,
Status1
));
}
// Return the first error status in case of failure
if (!EFI_ERROR (Status)) {
Status = Status1;
}
}
return Status;
}
/** A helper function to invoke a Table generator
This is a helper function that invokes the Table generator interface
for building an SMBIOS table. It uses the SmbiosProtocol to install the
table, then frees the resources allocated for generating it.
@param [in] TableFactoryProtocol Pointer to the Table Factory Protocol
interface.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@param [in] SmbiosProtocol Pointer to the SMBIOS protocol.
@param [in] SmbiosTableInfo Pointer to the SMBIOS table Info.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND Required object is not found.
@retval EFI_BAD_BUFFER_SIZE Size returned by the Configuration Manager
is less than the Object size for the
requested object.
**/
EFI_STATUS
EFIAPI
BuildAndInstallSmbiosTable (
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST TableFactoryProtocol,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,
IN EFI_SMBIOS_PROTOCOL *SmbiosProtocol,
IN CM_STD_OBJ_SMBIOS_TABLE_INFO *CONST SmbiosTableInfo
)
{
EFI_STATUS Status;
CONST SMBIOS_TABLE_GENERATOR *Generator;
ASSERT (TableFactoryProtocol != NULL);
ASSERT (CfgMgrProtocol != NULL);
ASSERT (SmbiosProtocol != NULL);
ASSERT (SmbiosTableInfo != NULL);
DEBUG ((
DEBUG_INFO,
"INFO: EStdObjSmbiosTableList: Address = 0x%p," \
" TableGeneratorId = 0x%x\n",
SmbiosTableInfo,
SmbiosTableInfo->TableGeneratorId
));
Generator = NULL;
Status = TableFactoryProtocol->GetSmbiosTableGenerator (
TableFactoryProtocol,
SmbiosTableInfo->TableGeneratorId,
&Generator
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Table Generator not found." \
" TableGeneratorId = 0x%x. Status = %r\n",
SmbiosTableInfo->TableGeneratorId,
Status
));
return Status;
}
if (Generator == NULL) {
return EFI_NOT_FOUND;
}
DEBUG ((
DEBUG_INFO,
"INFO: Generator found : %s\n",
Generator->Description
));
if (Generator->BuildSmbiosTableEx != NULL) {
Status = BuildAndInstallMultipleSmbiosTables (
TableFactoryProtocol,
CfgMgrProtocol,
Generator,
SmbiosProtocol,
SmbiosTableInfo
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to find build and install SMBIOS Tables." \
" Status = %r\n",
Status
));
}
} else if (Generator->BuildSmbiosTable != NULL) {
Status = BuildAndInstallSingleSmbiosTable (
TableFactoryProtocol,
CfgMgrProtocol,
Generator,
SmbiosProtocol,
SmbiosTableInfo
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to find build and install SMBIOS Table." \
" Status = %r\n",
Status
));
}
} else {
Status = EFI_INVALID_PARAMETER;
DEBUG ((
DEBUG_ERROR,
"ERROR: Table Generator does not implement the" \
"SMBIOS_TABLE_GENERATOR_BUILD_TABLE interface." \
" TableGeneratorId = 0x%x. Status = %r\n",
SmbiosTableInfo->TableGeneratorId,
Status
));
}
return Status;
}
/** Generate and install SMBIOS tables.
The function gathers the information necessary for installing the
SMBIOS tables from the Configuration Manager, invokes the generators
and installs them (via BuildAndInstallAcpiTable).
@param [in] TableFactoryProtocol Pointer to the Table Factory Protocol
interface.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
Protocol Interface.
@retval EFI_SUCCESS Success.
@retval EFI_NOT_FOUND If a mandatory table or a generator is not found.
**/
STATIC
EFI_STATUS
EFIAPI
ProcessSmbiosTables (
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST TableFactoryProtocol,
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol
)
{
EFI_STATUS Status;
EFI_SMBIOS_PROTOCOL *SmbiosProtocol;
CM_STD_OBJ_SMBIOS_TABLE_INFO *SmbiosTableInfo;
UINT32 SmbiosTableCount;
Status = gBS->LocateProtocol (
&gEfiSmbiosProtocolGuid,
NULL,
(VOID **)&SmbiosProtocol
);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Could not locate SMBIOS protocol. %r\n", Status));
return Status;
}
Status = GetEStdObjSmbiosTableList (
CfgMgrProtocol,
CM_NULL_TOKEN,
&SmbiosTableInfo,
&SmbiosTableCount
);
if (EFI_ERROR (Status)) {
if (Status == EFI_NOT_FOUND) {
// If the SMBIOS table list is not found the platform
// may not be publishing SMBIOS tables
// Log a warning and return success.
DEBUG ((
DEBUG_WARN,
"WARNING: Failed to get SMBIOS table List. Status = %r\n",
Status
));
Status = EFI_SUCCESS;
} else {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to get SMBIOS Table List. Status = %r\n",
Status
));
}
return Status;
}
if (SmbiosTableCount == 0) {
DEBUG ((
DEBUG_ERROR,
"ERROR: EStdObjSmbiosTableList: SmbiosTableCount = %d\n",
SmbiosTableCount
));
return EFI_NOT_FOUND;
}
DEBUG ((
DEBUG_INFO,
"INFO: EStdObjSmbiosTableList: SmbiosTableCount = %d\n",
SmbiosTableCount
));
InitSmbiosTableDispatcher (SmbiosTableInfo, SmbiosTableCount);
Status = DispatchSmbiosTables (
TableFactoryProtocol,
CfgMgrProtocol,
SmbiosProtocol,
SmbiosTableInfo,
SmbiosTableCount
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to install SMBIOS Tables.Status = %r\n",
Status
));
}
return Status;
}
/** SMBIOS table Protocol ready event handler.
This event notification indicates that the SMBIOS protocol is ready.
Therefore, dispatch the building of the SMBIOS tables.
@param [in] Event The Event that is signalled.
@param [in] Context The Context information.
@retval None
**/
VOID
EFIAPI
SmbiosProtocolReady (
IN EFI_EVENT Event,
IN VOID *Context
)
{
EFI_STATUS Status;
EDKII_CONFIGURATION_MANAGER_PROTOCOL *CfgMgrProtocol;
CM_STD_OBJ_CONFIGURATION_MANAGER_INFO *CfgMfrInfo;
EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *TableFactoryProtocol;
EFI_SMBIOS_PROTOCOL *SmbiosProtocol;
Status = gBS->LocateProtocol (
&gEfiSmbiosProtocolGuid,
NULL,
(VOID **)&SmbiosProtocol
);
// The event handler function is called at least once
// during installation even if the protocol is not available
// at that point.
if (EFI_ERROR (Status)) {
return;
}
// Locate the Dynamic Table Factory
Status = gBS->LocateProtocol (
&gEdkiiDynamicTableFactoryProtocolGuid,
NULL,
(VOID **)&TableFactoryProtocol
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to find Dynamic Table Factory protocol." \
" Status = %r\n",
Status
));
return;
}
// Locate the Configuration Manager for the Platform
Status = gBS->LocateProtocol (
&gEdkiiConfigurationManagerProtocolGuid,
NULL,
(VOID **)&CfgMgrProtocol
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to find Configuration Manager protocol. Status = %r\n",
Status
));
return;
}
Status = GetCgfMgrInfo (CfgMgrProtocol, &CfgMfrInfo);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to get Configuration Manager info. Status = %r\n",
Status
));
return;
}
DEBUG ((
DEBUG_INFO,
"INFO: Configuration Manager Version = 0x%x, OemID = %c%c%c%c%c%c\n",
CfgMfrInfo->Revision,
CfgMfrInfo->OemId[0],
CfgMfrInfo->OemId[1],
CfgMfrInfo->OemId[2],
CfgMfrInfo->OemId[3],
CfgMfrInfo->OemId[4],
CfgMfrInfo->OemId[5]
));
Status = ProcessSmbiosTables (TableFactoryProtocol, CfgMgrProtocol);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: SMBIOS Table processing failure. Status = %r\n",
Status
));
}
Status = gBS->CloseEvent (Event);
ASSERT_EFI_ERROR (Status);
}
|
