]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SmbiosDxe/SmbiosDxe.c
projects / mirror_edk2.git / blob
? search:


a3a85d59db4cc2ec6187b19afc2e9f7b32d96f57
[mirror_edk2.git] / MdeModulePkg / Universal / SmbiosDxe / SmbiosDxe.c
1 /** @file
2 This code produces the Smbios protocol. It also responsible for constructing
3 SMBIOS table into system table.
4
5 Copyright (c) 2009, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "SmbiosDxe.h"
17
18 //
19 // Module Global:
20 // Since this driver will only ever produce one instance of the
21 // protocol you are not required to dynamically allocate the PrivateData.
22 //
23 SMBIOS_INSTANCE mPrivateData;
24
25 //
26 // Chassis for SMBIOS entry point structure that is to be installed into EFI system config table.
27 //
28 SMBIOS_TABLE_ENTRY_POINT *EntryPointStructure = NULL;
29 SMBIOS_TABLE_ENTRY_POINT EntryPointStructureData = {
30 //
31 // AnchorString
32 //
33 {
34 0x5f,
35 0x53,
36 0x4d,
37 0x5f
38 },
39 //
40 // EntryPointStructureChecksum,TO BE FILLED
41 //
42 0,
43 //
44 // EntryPointStructure Length
45 //
46 0x1f,
47 //
48 // MajorVersion: 2 (Version 2.4)
49 //
50 0x02,
51 //
52 // MinorVersion: 4 (Version 2.4)
53 //
54 0x04,
55 //
56 // MaxStructureSize, TO BE FILLED
57 //
58 0,
59 //
60 // EntryPointRevision
61 //
62 0,
63 //
64 // FormattedArea
65 //
66 {
67 0,
68 0,
69 0,
70 0,
71 0
72 },
73 //
74 // IntermediateAnchorString
75 //
76 {
77 0x5f,
78 0x44,
79 0x4d,
80 0x49,
81 0x5f
82 },
83 //
84 // IntermediateChecksum, TO BE FILLED
85 //
86 0,
87 //
88 // StructureTableLength, TO BE FILLED
89 //
90 0,
91 //
92 // StructureTableAddress, TO BE FILLED
93 //
94 0,
95 //
96 // NumberOfSmbiosStructures, TO BE FILLED
97 //
98 0,
99 //
100 // SmbiosBcdRevision
101 //
102 0
103 };
104
105
106 /**
107
108 Get the full size of smbios structure including optional strings that follow the formatted structure.
109
110 @param Head Pointer to the beginning of smbios structure.
111 @param Size The returned size.
112 @param NumberOfStrings The returned number of optional strings that follow the formatted structure.
113
114 @retval EFI_SUCCESS Size retured in Size.
115 @retval EFI_INVALID_PARAMETER Input smbios structure mal-formed or Size is NULL.
116
117 **/
118 EFI_STATUS
119 EFIAPI
120 GetSmbiosStructureSize (
121 IN EFI_SMBIOS_TABLE_HEADER *Head,
122 OUT UINTN *Size,
123 OUT UINTN *NumberOfStrings
124 )
125 {
126 UINTN FullSize;
127 UINT8 StrLen;
128 INT8* CharInStr;
129
130 if (Size == NULL || NumberOfStrings == NULL) {
131 return EFI_INVALID_PARAMETER;
132 }
133
134 FullSize = Head->Length;
135 CharInStr = (INT8*)Head + Head->Length;
136 *Size = FullSize;
137 *NumberOfStrings = 0;
138 StrLen = 0;
139 //
140 // look for the two consecutive zeros, check the string limit by the way.
141 //
142 while (*CharInStr != 0 || *(CharInStr+1) != 0) {
143 if (*CharInStr == 0) {
144 *Size += 1;
145 CharInStr++;
146 }
147
148 for (StrLen = 0 ; StrLen < SMBIOS_STRING_MAX_LENGTH; StrLen++) {
149 if (*(CharInStr+StrLen) == 0) {
150 break;
151 }
152 }
153
154 if (StrLen == SMBIOS_STRING_MAX_LENGTH) {
155 return EFI_INVALID_PARAMETER;
156 }
157 //
158 // forward the pointer
159 //
160 CharInStr += StrLen;
161 *Size += StrLen;
162 *NumberOfStrings += 1;
163 }
164
165 //
166 // count ending two zeros.
167 //
168 *Size += 2;
169 return EFI_SUCCESS;
170 }
171
172 /**
173
174 Determin whether an SmbiosHandle has already in use.
175
176 @param Head Pointer to the beginning of smbios structure.
177 @param Handle A unique handle will be assigned to the SMBIOS record.
178
179 @retval TRUE Smbios handle already in use.
180 @retval FALSE Smbios handle is NOT used.
181
182 **/
183 BOOLEAN
184 EFIAPI
185 CheckSmbiosHandleExistance (
186 IN LIST_ENTRY *Head,
187 IN EFI_SMBIOS_HANDLE Handle
188 )
189 {
190 LIST_ENTRY *Link;
191 SMBIOS_HANDLE_ENTRY *HandleEntry;
192
193 for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {
194 HandleEntry = SMBIOS_HANDLE_ENTRY_FROM_LINK(Link);
195 if (HandleEntry->SmbiosHandle == Handle) {
196 return TRUE;
197 }
198 }
199
200 return FALSE;
201 }
202
203 /**
204
205 Get the max SmbiosHandle that could be use.
206
207 @param This The EFI_SMBIOS_PROTOCOL instance.
208 @param MaxHandle The max handle that could be assigned to the SMBIOS record.
209
210 **/
211 VOID
212 EFIAPI
213 GetMaxSmbiosHandle (
214 IN CONST EFI_SMBIOS_PROTOCOL *This,
215 IN OUT EFI_SMBIOS_HANDLE *MaxHandle
216 )
217 {
218 if (This->MajorVersion == 2 && This->MinorVersion == 0) {
219 *MaxHandle = 0xFFFE;
220 } else {
221 *MaxHandle = 0xFEFF;
222 }
223 }
224
225 /**
226
227 Get an SmbiosHandle that could use.
228
229 @param This The EFI_SMBIOS_PROTOCOL instance.
230 @param SmbiosHandle A unique handle will be assigned to the SMBIOS record.
231
232 @retval EFI_SUCCESS Smbios handle got.
233 @retval EFI_OUT_OF_RESOURCES Smbios handle is NOT available.
234
235 **/
236 EFI_STATUS
237 EFIAPI
238 GetAvailableSmbiosHandle (
239 IN CONST EFI_SMBIOS_PROTOCOL *This,
240 IN OUT EFI_SMBIOS_HANDLE *Handle
241 )
242 {
243 LIST_ENTRY *Head;
244 SMBIOS_INSTANCE *Private;
245 EFI_SMBIOS_HANDLE MaxSmbiosHandle;
246 EFI_SMBIOS_HANDLE AvailableHandle;
247
248 GetMaxSmbiosHandle(This, &MaxSmbiosHandle);
249
250 Private = SMBIOS_INSTANCE_FROM_THIS (This);
251 Head = &Private->AllocatedHandleListHead;
252 for (AvailableHandle = 1; AvailableHandle < MaxSmbiosHandle; AvailableHandle++) {
253 if (!CheckSmbiosHandleExistance(Head, AvailableHandle)) {
254 *Handle = AvailableHandle;
255 return EFI_SUCCESS;
256 }
257 }
258
259 return EFI_OUT_OF_RESOURCES;
260 }
261
262
263 /**
264 Add an SMBIOS record.
265
266 @param This The EFI_SMBIOS_PROTOCOL instance.
267 @param ProducerHandle The handle of the controller or driver associated with the SMBIOS information. NULL
268 means no handle.
269 @param SmbiosHandle On entry, if non-zero, the handle of the SMBIOS record. If zero, then a unique handle
270 will be assigned to the SMBIOS record. If the SMBIOS handle is already in use
271 EFI_ALREADY_STARTED is returned and the SMBIOS record is not updated.
272 @param Record The data for the fixed portion of the SMBIOS record. The format of the record is
273 determined by EFI_SMBIOS_TABLE_HEADER.Type. The size of the formatted area is defined
274 by EFI_SMBIOS_TABLE_HEADER.Length and either followed by a double-null (0x0000) or
275 a set of null terminated strings and a null.
276
277 @retval EFI_SUCCESS Record was added.
278 @retval EFI_OUT_OF_RESOURCES Record was not added due to lack of system resources.
279 @retval EFI_ALREADY_STARTED The SmbiosHandle passed in was already in use.
280
281 **/
282 EFI_STATUS
283 EFIAPI
284 SmbiosAdd (
285 IN CONST EFI_SMBIOS_PROTOCOL *This,
286 IN EFI_HANDLE ProducerHandle, OPTIONAL
287 IN OUT EFI_SMBIOS_HANDLE *SmbiosHandle,
288 IN EFI_SMBIOS_TABLE_HEADER *Record
289 )
290 {
291 VOID *Raw;
292 UINTN TotalSize;
293 UINTN RecordSize;
294 UINTN StructureSize;
295 UINTN NumberOfStrings;
296 EFI_STATUS Status;
297 LIST_ENTRY *Head;
298 SMBIOS_INSTANCE *Private;
299 EFI_SMBIOS_ENTRY *SmbiosEntry;
300 EFI_SMBIOS_HANDLE MaxSmbiosHandle;
301 SMBIOS_HANDLE_ENTRY *HandleEntry;
302 EFI_SMBIOS_RECORD_HEADER *InternalRecord;
303
304 if (SmbiosHandle == NULL) {
305 return EFI_INVALID_PARAMETER;
306 }
307
308 Private = SMBIOS_INSTANCE_FROM_THIS (This);
309 //
310 // Check whether SmbiosHandle is already in use
311 //
312 Head = &Private->AllocatedHandleListHead;
313 if (*SmbiosHandle != 0 && CheckSmbiosHandleExistance(Head, *SmbiosHandle)) {
314 return EFI_ALREADY_STARTED;
315 }
316
317 //
318 // when SmbiosHandle is zero, an available handle will be assigned
319 //
320 if (*SmbiosHandle == 0) {
321 Status = GetAvailableSmbiosHandle(This, SmbiosHandle);
322 if (EFI_ERROR(Status)) {
323 return Status;
324 }
325 } else {
326 //
327 // Check this handle validity
328 //
329 GetMaxSmbiosHandle(This, &MaxSmbiosHandle);
330 if (*SmbiosHandle > MaxSmbiosHandle) {
331 return EFI_INVALID_PARAMETER;
332 }
333 }
334
335 //
336 // Calculate record size and string number
337 //
338 Status = GetSmbiosStructureSize(Record, &StructureSize, &NumberOfStrings);
339 if (EFI_ERROR(Status)) {
340 return Status;
341 }
342
343 //
344 // Enter into critical section
345 //
346 Status = EfiAcquireLockOrFail (&Private->DataLock);
347 if (EFI_ERROR (Status)) {
348 return Status;
349 }
350
351 RecordSize = sizeof (EFI_SMBIOS_RECORD_HEADER) + StructureSize;
352 TotalSize = sizeof (EFI_SMBIOS_ENTRY) + RecordSize;
353
354 //
355 // Allocate internal buffer
356 //
357 SmbiosEntry = AllocateZeroPool (TotalSize);
358 if (SmbiosEntry == NULL) {
359 EfiReleaseLock (&Private->DataLock);
360 return EFI_OUT_OF_RESOURCES;
361 }
362 HandleEntry = AllocateZeroPool (sizeof(SMBIOS_HANDLE_ENTRY));
363 if (HandleEntry == NULL) {
364 EfiReleaseLock (&Private->DataLock);
365 return EFI_OUT_OF_RESOURCES;
366 }
367
368 //
369 // Build Handle Entry and insert into linked list
370 //
371 HandleEntry->Signature = SMBIOS_HANDLE_ENTRY_SIGNATURE;
372 HandleEntry->SmbiosHandle = *SmbiosHandle;
373 InsertTailList(&Private->AllocatedHandleListHead, &HandleEntry->Link);
374
375 InternalRecord = (EFI_SMBIOS_RECORD_HEADER *) (SmbiosEntry + 1);
376 Raw = (VOID *) (InternalRecord + 1);
377
378 //
379 // Build internal record Header
380 //
381 InternalRecord->Version = EFI_SMBIOS_RECORD_HEADER_VERSION;
382 InternalRecord->HeaderSize = sizeof (EFI_SMBIOS_RECORD_HEADER);
383 InternalRecord->RecordSize = RecordSize;
384 InternalRecord->ProducerHandle = ProducerHandle;
385 InternalRecord->NumberOfStrings = NumberOfStrings;
386 //
387 // Insert record into the internal linked list
388 //
389 SmbiosEntry->Signature = EFI_SMBIOS_ENTRY_SIGNATURE;
390 SmbiosEntry->RecordHeader = InternalRecord;
391 SmbiosEntry->RecordSize = TotalSize;
392 InsertTailList (&Private->DataListHead, &SmbiosEntry->Link);
393
394 CopyMem (Raw, Record, StructureSize);
395 ((EFI_SMBIOS_TABLE_HEADER*)Raw)->Handle = *SmbiosHandle;
396
397 //
398 // Leave critical section
399 //
400 EfiReleaseLock (&Private->DataLock);
401 return EFI_SUCCESS;
402 }
403
404 /**
405 Update the string associated with an existing SMBIOS record.
406
407 @param This The EFI_SMBIOS_PROTOCOL instance.
408 @param SmbiosHandle SMBIOS Handle of structure that will have its string updated.
409 @param StringNumber The non-zero string number of the string to update
410 @param String Update the StringNumber string with String.
411
412 @retval EFI_SUCCESS SmbiosHandle had its StringNumber String updated.
413 @retval EFI_INVALID_PARAMETER SmbiosHandle does not exist.
414 @retval EFI_UNSUPPORTED String was not added since it's longer than 64 significant characters.
415 @retval EFI_NOT_FOUND The StringNumber.is not valid for this SMBIOS record.
416
417 **/
418 EFI_STATUS
419 EFIAPI
420 SmbiosUpdateString (
421 IN CONST EFI_SMBIOS_PROTOCOL *This,
422 IN EFI_SMBIOS_HANDLE *SmbiosHandle,
423 IN UINTN *StringNumber,
424 IN CHAR8 *String
425 )
426 {
427 UINTN InputStrLen;
428 UINTN TargetStrLen;
429 UINTN StrIndex;
430 UINTN TargetStrOffset;
431 UINTN NewEntrySize;
432 CHAR8 *StrStart;
433 VOID *Raw;
434 LIST_ENTRY *Link;
435 LIST_ENTRY *Head;
436 EFI_STATUS Status;
437 SMBIOS_INSTANCE *Private;
438 EFI_SMBIOS_ENTRY *SmbiosEntry;
439 EFI_SMBIOS_ENTRY *ResizedSmbiosEntry;
440 EFI_SMBIOS_HANDLE MaxSmbiosHandle;
441 EFI_SMBIOS_TABLE_HEADER *Record;
442 EFI_SMBIOS_RECORD_HEADER *InternalRecord;
443
444 //
445 // Check args validity
446 //
447 GetMaxSmbiosHandle(This, &MaxSmbiosHandle);
448
449 if (*SmbiosHandle > MaxSmbiosHandle) {
450 return EFI_INVALID_PARAMETER;
451 }
452
453 if (String == NULL) {
454 return EFI_ABORTED;
455 }
456
457 if (*StringNumber == 0) {
458 return EFI_NOT_FOUND;
459 }
460
461 InputStrLen = AsciiStrLen(String);
462 if (InputStrLen > SMBIOS_STRING_MAX_LENGTH) {
463 return EFI_UNSUPPORTED;
464 }
465
466 Private = SMBIOS_INSTANCE_FROM_THIS (This);
467 //
468 // Enter into critical section
469 //
470 Status = EfiAcquireLockOrFail (&Private->DataLock);
471 if (EFI_ERROR (Status)) {
472 return Status;
473 }
474
475 Head = &Private->DataListHead;
476 for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {
477 SmbiosEntry = SMBIOS_ENTRY_FROM_LINK(Link);
478 Record = (EFI_SMBIOS_TABLE_HEADER*)(SmbiosEntry->RecordHeader + 1);
479
480 if ((UINTN)Record->Handle == *SmbiosHandle) {
481 //
482 // Find out the specified Smbios record
483 //
484 if (*StringNumber > SmbiosEntry->RecordHeader->NumberOfStrings) {
485 EfiReleaseLock (&Private->DataLock);
486 return EFI_NOT_FOUND;
487 }
488 //
489 // Point to unformed string section
490 //
491 StrStart = (CHAR8*)Record + Record->Length;
492
493 for (StrIndex = 1, TargetStrOffset = 0; StrIndex < *StringNumber; StrStart++, TargetStrOffset++) {
494 //
495 // A string ends in 00h
496 //
497 if (*StrStart == 0) {
498 StrIndex++;
499 }
500
501 //
502 // String section ends in double-null (0000h)
503 //
504 if (*StrStart == 0 && *(StrStart + 1) == 0) {
505 EfiReleaseLock (&Private->DataLock);
506 return EFI_NOT_FOUND;
507 }
508 }
509
510 if (*StrStart == 0) {
511 StrStart ++;
512 TargetStrOffset ++;
513 }
514
515 //
516 // Now we get the string target
517 //
518 TargetStrLen = AsciiStrLen(StrStart);
519 if (InputStrLen == TargetStrLen) {
520 AsciiStrCpy(StrStart, String);
521 EfiReleaseLock (&Private->DataLock);
522 return EFI_SUCCESS;
523 }
524
525 //
526 // Original string buffer size is not exactly match input string length.
527 // Re-allocate buffer is needed.
528 //
529 NewEntrySize = SmbiosEntry->RecordSize + InputStrLen - TargetStrLen;
530 ResizedSmbiosEntry = AllocateZeroPool (NewEntrySize);
531
532 if (ResizedSmbiosEntry == NULL) {
533 EfiReleaseLock (&Private->DataLock);
534 return EFI_OUT_OF_RESOURCES;
535 }
536
537 InternalRecord = (EFI_SMBIOS_RECORD_HEADER *) (ResizedSmbiosEntry + 1);
538 Raw = (VOID *) (InternalRecord + 1);
539
540 //
541 // Build internal record Header
542 //
543 InternalRecord->Version = EFI_SMBIOS_RECORD_HEADER_VERSION;
544 InternalRecord->HeaderSize = sizeof (EFI_SMBIOS_RECORD_HEADER);
545 InternalRecord->RecordSize = SmbiosEntry->RecordHeader->RecordSize + InputStrLen - TargetStrLen;
546 InternalRecord->ProducerHandle = SmbiosEntry->RecordHeader->ProducerHandle;
547 InternalRecord->NumberOfStrings = SmbiosEntry->RecordHeader->NumberOfStrings;
548
549 //
550 // Copy smbios structure and optional strings.
551 //
552 CopyMem (Raw, SmbiosEntry->RecordHeader + 1, Record->Length + TargetStrOffset);
553 CopyMem ((VOID*)((UINTN)Raw + Record->Length + TargetStrOffset), String, InputStrLen + 1);
554 CopyMem ((CHAR8*)((UINTN)Raw + Record->Length + TargetStrOffset + InputStrLen + 1),
555 (CHAR8*)Record + Record->Length + TargetStrOffset + TargetStrLen + 1,
556 SmbiosEntry->RecordHeader->RecordSize - sizeof (EFI_SMBIOS_RECORD_HEADER) - Record->Length - TargetStrOffset - TargetStrLen - 1);
557
558 //
559 // Insert new record
560 //
561 ResizedSmbiosEntry->Signature = EFI_SMBIOS_ENTRY_SIGNATURE;
562 ResizedSmbiosEntry->RecordHeader = InternalRecord;
563 ResizedSmbiosEntry->RecordSize = NewEntrySize;
564 InsertTailList (Link->ForwardLink, &ResizedSmbiosEntry->Link);
565
566 //
567 // Remove old record
568 //
569 RemoveEntryList(Link);
570 FreePool(SmbiosEntry);
571 EfiReleaseLock (&Private->DataLock);
572 return EFI_SUCCESS;
573 }
574 }
575
576 EfiReleaseLock (&Private->DataLock);
577 return EFI_INVALID_PARAMETER;
578 }
579
580 /**
581 Remove an SMBIOS record.
582
583 @param This The EFI_SMBIOS_PROTOCOL instance.
584 @param SmbiosHandle The handle of the SMBIOS record to remove.
585
586 @retval EFI_SUCCESS SMBIOS record was removed.
587 @retval EFI_INVALID_PARAMETER SmbiosHandle does not specify a valid SMBIOS record.
588
589 **/
590 EFI_STATUS
591 EFIAPI
592 SmbiosRemove (
593 IN CONST EFI_SMBIOS_PROTOCOL *This,
594 IN EFI_SMBIOS_HANDLE SmbiosHandle
595 )
596 {
597 LIST_ENTRY *Link;
598 LIST_ENTRY *Head;
599 EFI_STATUS Status;
600 EFI_SMBIOS_HANDLE MaxSmbiosHandle;
601 SMBIOS_INSTANCE *Private;
602 EFI_SMBIOS_ENTRY *SmbiosEntry;
603 SMBIOS_HANDLE_ENTRY *HandleEntry;
604 EFI_SMBIOS_TABLE_HEADER *Record;
605
606 //
607 // Check args validity
608 //
609 GetMaxSmbiosHandle(This, &MaxSmbiosHandle);
610
611 if (SmbiosHandle > MaxSmbiosHandle) {
612 return EFI_INVALID_PARAMETER;
613 }
614
615 Private = SMBIOS_INSTANCE_FROM_THIS (This);
616 //
617 // Enter into critical section
618 //
619 Status = EfiAcquireLockOrFail (&Private->DataLock);
620 if (EFI_ERROR (Status)) {
621 return Status;
622 }
623
624 Head = &Private->DataListHead;
625 for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {
626 SmbiosEntry = SMBIOS_ENTRY_FROM_LINK(Link);
627 Record = (EFI_SMBIOS_TABLE_HEADER*)(SmbiosEntry->RecordHeader + 1);
628 if ((UINTN)Record->Handle == SmbiosHandle) {
629 //
630 // Remove specified smobios record from DataList
631 //
632 RemoveEntryList(Link);
633 FreePool(SmbiosEntry);
634 //
635 // Remove this handle from AllocatedHandleList
636 //
637 Head = &Private->AllocatedHandleListHead;
638 for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {
639 HandleEntry = SMBIOS_HANDLE_ENTRY_FROM_LINK(Link);
640 if ((UINTN)HandleEntry->SmbiosHandle == SmbiosHandle) {
641 RemoveEntryList(Link);
642 FreePool(HandleEntry);
643 break;
644 }
645 }
646 EfiReleaseLock (&Private->DataLock);
647 return EFI_SUCCESS;
648 }
649 }
650
651 //
652 // Leave critical section
653 //
654 EfiReleaseLock (&Private->DataLock);
655 return EFI_INVALID_PARAMETER;
656
657 }
658
659 /**
660 Allow the caller to discover all or some of the SMBIOS records.
661
662 @param This The EFI_SMBIOS_PROTOCOL instance.
663 @param SmbiosHandle On entry, points to the previous handle of the SMBIOS record. On exit, points to the
664 next SMBIOS record handle. If it is zero on entry, then the first SMBIOS record
665 handle will be returned. If it returns zero on exit, then there are no more SMBIOS records.
666 @param Type On entry it means return the next SMBIOS record of type Type. If a NULL is passed in
667 this functionally it ignored. Type is not modified by the GetNext() function.
668 @param Record On exit, points to the SMBIOS Record consisting of the formatted area followed by
669 the unformatted area. The unformatted area optionally contains text strings.
670 @param ProducerHandle On exit, points to the ProducerHandle registered by Add(). If no ProducerHandle was passed into Add() NULL is returned.
671 If a NULL pointer is passed in no data will be returned
672
673 @retval EFI_SUCCESS SMBIOS record information was successfully returned in Record.
674 SmbiosHandle is the handle of the current SMBIOS record
675 @retval EFI_NOT_FOUND The SMBIOS record with SmbiosHandle was the last available record.
676
677 **/
678 EFI_STATUS
679 EFIAPI
680 SmbiosGetNext (
681 IN CONST EFI_SMBIOS_PROTOCOL *This,
682 IN OUT EFI_SMBIOS_HANDLE *SmbiosHandle,
683 IN EFI_SMBIOS_TYPE *Type, OPTIONAL
684 OUT EFI_SMBIOS_TABLE_HEADER **Record,
685 OUT EFI_HANDLE *ProducerHandle OPTIONAL
686 )
687 {
688 BOOLEAN StartPointFound;
689 LIST_ENTRY *Link;
690 LIST_ENTRY *Head;
691 SMBIOS_INSTANCE *Private;
692 EFI_SMBIOS_ENTRY *SmbiosEntry;
693 EFI_SMBIOS_TABLE_HEADER *SmbiosTableHeader;
694
695 if (SmbiosHandle == NULL) {
696 return EFI_INVALID_PARAMETER;
697 }
698
699 StartPointFound = FALSE;
700 Private = SMBIOS_INSTANCE_FROM_THIS (This);
701 Head = &Private->DataListHead;
702 for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {
703 SmbiosEntry = SMBIOS_ENTRY_FROM_LINK(Link);
704 SmbiosTableHeader = (EFI_SMBIOS_TABLE_HEADER*)(SmbiosEntry->RecordHeader + 1);
705
706 //
707 // If SmbiosHandle is zero, the first matched SMBIOS record handle will be returned
708 //
709 if (*SmbiosHandle == 0) {
710 if ((Type != NULL) && (*Type != SmbiosTableHeader->Type)) {
711 continue;
712 }
713
714 *SmbiosHandle = SmbiosTableHeader->Handle;
715 *Record =SmbiosTableHeader;
716 if (ProducerHandle != NULL) {
717 *ProducerHandle = SmbiosEntry->RecordHeader->ProducerHandle;
718 }
719 return EFI_SUCCESS;
720 }
721
722 //
723 // Start this round search from the next Smbios handle
724 //
725 if (!StartPointFound && (*SmbiosHandle == SmbiosTableHeader->Handle)) {
726 StartPointFound = TRUE;
727 continue;
728 }
729
730 if (StartPointFound) {
731 if ((Type != NULL) && (*Type != SmbiosTableHeader->Type)) {
732 continue;
733 }
734
735 *SmbiosHandle = SmbiosTableHeader->Handle;
736 *Record = SmbiosTableHeader;
737 if (ProducerHandle != NULL) {
738 *ProducerHandle = SmbiosEntry->RecordHeader->ProducerHandle;
739 }
740
741 return EFI_SUCCESS;
742 }
743 }
744
745 *SmbiosHandle = 0;
746 return EFI_NOT_FOUND;
747
748 }
749
750
751 /**
752 Assembles Smbios table from the SMBIOS protocol. Produce Table
753 Entry Point and return the pointer to it.
754
755 @param TableEntryPointStructure On exit, points to the SMBIOS entrypoint structure.
756
757 @retval EFI_SUCCESS Structure created sucessfully.
758 @retval EFI_NOT_READY Some of The SMBIOS records was not available yet.
759 @retval EFI_OUT_OF_RESOURCES No enough memory.
760
761 **/
762 EFI_STATUS
763 EFIAPI
764 SmbiosCreateTable (
765 OUT VOID **TableEntryPointStructure
766 )
767 {
768 UINT8 CheckSum;
769 UINT8 *BufferPointer;
770 UINTN Index;
771 UINTN RecordSize;
772 UINTN NumOfStr;
773 EFI_STATUS Status;
774 EFI_SMBIOS_HANDLE SmbiosHandle;
775 EFI_SMBIOS_PROTOCOL *SmbiosProtocol;
776 EFI_PHYSICAL_ADDRESS PhysicalAddress;
777 EFI_SMBIOS_TABLE_HEADER *SmbiosRecord;
778 EFI_SMBIOS_TABLE_END_STRUCTURE EndStructure;
779
780 Status = EFI_SUCCESS;
781 BufferPointer = NULL;
782 CheckSum = 0;
783
784 //
785 // Initialize the EntryPointStructure with initial values.
786 //
787 if (EntryPointStructure == NULL) {
788 //
789 // Allocate memory (below 4GB)
790 //
791 PhysicalAddress = 0xffffffff;
792 Status = gBS->AllocatePages (
793 AllocateMaxAddress,
794 EfiReservedMemoryType,
795 EFI_SIZE_TO_PAGES (sizeof (SMBIOS_TABLE_ENTRY_POINT)),
796 &PhysicalAddress
797 );
798 if (EFI_ERROR (Status)) {
799 return EFI_OUT_OF_RESOURCES;
800 }
801
802 EntryPointStructure = (SMBIOS_TABLE_ENTRY_POINT *) (UINTN) PhysicalAddress;
803
804 CopyMem (
805 EntryPointStructure,
806 &EntryPointStructureData,
807 sizeof (SMBIOS_TABLE_ENTRY_POINT)
808 );
809 }
810
811 //
812 // Free the original image
813 //
814 if (EntryPointStructure->TableAddress != 0) {
815 FreePages (
816 (VOID*)(UINTN)EntryPointStructure->TableAddress,
817 EFI_SIZE_TO_PAGES (EntryPointStructure->TableLength)
818 );
819 EntryPointStructure->TableAddress = 0;
820 }
821
822 //
823 // Locate smbios protocol to traverse smbios records.
824 //
825 Status = gBS->LocateProtocol (&gEfiSmbiosProtocolGuid, NULL, (VOID **) &SmbiosProtocol);
826 ASSERT_EFI_ERROR (Status);
827 ASSERT (SmbiosProtocol != NULL);
828
829 //
830 // Make some statistics about all the structures
831 //
832 EntryPointStructure->NumberOfSmbiosStructures = 0;
833 EntryPointStructure->TableLength = 0;
834 EntryPointStructure->MaxStructureSize = 0;
835 SmbiosHandle = 0;
836
837 //
838 // Calculate EPS Table Length
839 //
840 do {
841 Status = SmbiosProtocol->GetNext (
842 SmbiosProtocol,
843 &SmbiosHandle,
844 NULL,
845 &SmbiosRecord,
846 NULL
847 );
848
849 if (Status == EFI_SUCCESS) {
850 GetSmbiosStructureSize(SmbiosRecord, &RecordSize, &NumOfStr);
851 //
852 // Record NumberOfSmbiosStructures, TableLength and MaxStructureSize
853 //
854 EntryPointStructure->NumberOfSmbiosStructures ++;
855 EntryPointStructure->TableLength = (UINT16) (EntryPointStructure->TableLength + RecordSize);
856 if (RecordSize > EntryPointStructure->MaxStructureSize) {
857 EntryPointStructure->MaxStructureSize = (UINT16) RecordSize;
858 }
859 }
860 } while (!EFI_ERROR(Status));
861
862 //
863 // Create End-Of-Table structure
864 //
865 GetMaxSmbiosHandle(SmbiosProtocol, &SmbiosHandle);
866 EndStructure.Header.Type = EFI_SMBIOS_TYPE_END_OF_TABLE;
867 EndStructure.Header.Length = sizeof(EFI_SMBIOS_TABLE_HEADER);
868 EndStructure.Header.Handle = SmbiosHandle;
869 EndStructure.Tailing[0] = 0;
870 EndStructure.Tailing[1] = 0;
871 EntryPointStructure->NumberOfSmbiosStructures++;
872 EntryPointStructure->TableLength = (UINT16) (EntryPointStructure->TableLength + sizeof (EndStructure));
873 if (sizeof (EndStructure) > EntryPointStructure->MaxStructureSize) {
874 EntryPointStructure->MaxStructureSize = (UINT16) sizeof (EndStructure);
875 }
876
877 //
878 // Allocate memory (below 4GB)
879 //
880 PhysicalAddress = 0xffffffff;
881 Status = gBS->AllocatePages (
882 AllocateMaxAddress,
883 EfiReservedMemoryType,
884 EFI_SIZE_TO_PAGES (EntryPointStructure->TableLength),
885 &PhysicalAddress
886 );
887 if (EFI_ERROR (Status)) {
888 FreePages ((VOID*)(UINTN)EntryPointStructure, EFI_SIZE_TO_PAGES (EntryPointStructure->TableLength));
889 EntryPointStructure = NULL;
890 return EFI_OUT_OF_RESOURCES;
891 }
892
893 EntryPointStructure->TableAddress = (UINT32) PhysicalAddress;
894
895 //
896 // Assemble the tables
897 //
898 BufferPointer = (UINT8 *) (UINTN) PhysicalAddress;
899 SmbiosHandle = 0;
900 do {
901 Status = SmbiosProtocol->GetNext (
902 SmbiosProtocol,
903 &SmbiosHandle,
904 NULL,
905 &SmbiosRecord,
906 NULL
907 );
908 if (Status == EFI_SUCCESS) {
909 GetSmbiosStructureSize(SmbiosRecord, &RecordSize, &NumOfStr);
910 CopyMem (BufferPointer, SmbiosRecord, RecordSize);
911 BufferPointer = BufferPointer + RecordSize;
912 }
913 } while (!EFI_ERROR(Status));
914
915 //
916 // Assemble End-Of-Table structure
917 //
918 CopyMem (BufferPointer, &EndStructure, sizeof (EndStructure));
919
920 //
921 // Fixup checksums in the Entry Point Structure
922 //
923 CheckSum = 0;
924 EntryPointStructure->IntermediateChecksum = 0;
925 for (Index = 0x10; Index < EntryPointStructure->EntryPointLength; Index++) {
926 CheckSum = (UINT8) (CheckSum + ((UINT8 *) (EntryPointStructure))[Index]);
927 }
928
929 EntryPointStructure->IntermediateChecksum = (UINT8) (0 - CheckSum);
930
931 CheckSum = 0;
932 EntryPointStructure->EntryPointStructureChecksum = 0;
933 for (Index = 0x0; Index < EntryPointStructure->EntryPointLength; Index++) {
934 CheckSum = (UINT8) (CheckSum + ((UINT8 *) (EntryPointStructure))[Index]);
935 }
936
937 EntryPointStructure->EntryPointStructureChecksum = (UINT8) (0 - CheckSum);
938
939 //
940 // Returns the pointer
941 //
942 *TableEntryPointStructure = EntryPointStructure;
943
944 return EFI_SUCCESS;
945 }
946
947
948
949 /**
950 Installs the Smbios Table to the System Table. This function gets called
951 when the EFI_EVENT_SIGNAL_READY_TO_BOOT gets signaled
952
953 @param Event The event to signal
954 @param Context Event contex
955
956 **/
957 VOID
958 EFIAPI
959 SmbiosTableConstruction (
960 IN EFI_EVENT Event,
961 IN VOID *Context
962 )
963 {
964 UINT8 *Eps;
965 EFI_STATUS Status;
966
967 Status = SmbiosCreateTable ((VOID **) &Eps);
968 if (!EFI_ERROR (Status)) {
969 gBS->InstallConfigurationTable (&gEfiSmbiosTableGuid, Eps);
970 }
971 }
972
973
974 /**
975
976 Driver to produce Smbios protocol and register event for constructing SMBIOS table.
977
978 @param ImageHandle Module's image handle
979 @param SystemTable Pointer of EFI_SYSTEM_TABLE
980
981 @retval EFI_SUCCESS Smbios protocol installed
982 @retval Other No protocol installed, unload driver.
983
984 **/
985 EFI_STATUS
986 EFIAPI
987 SmbiosDriverEntryPoint (
988 IN EFI_HANDLE ImageHandle,
989 IN EFI_SYSTEM_TABLE *SystemTable
990 )
991 {
992 EFI_STATUS Status;
993 EFI_EVENT ReadyToBootEvent;
994
995 mPrivateData.Signature = SMBIOS_INSTANCE_SIGNATURE;
996 mPrivateData.Smbios.Add = SmbiosAdd;
997 mPrivateData.Smbios.UpdateString = SmbiosUpdateString;
998 mPrivateData.Smbios.Remove = SmbiosRemove;
999 mPrivateData.Smbios.GetNext = SmbiosGetNext;
1000 mPrivateData.Smbios.MajorVersion = SMBIOS_MAJOR_VERSION;
1001 mPrivateData.Smbios.MinorVersion = SMBIOS_MINOR_VERSION;
1002
1003 InitializeListHead (&mPrivateData.DataListHead);
1004 InitializeListHead (&mPrivateData.AllocatedHandleListHead);
1005 EfiInitializeLock (&mPrivateData.DataLock, TPL_NOTIFY);
1006
1007 //
1008 // Make a new handle and install the protocol
1009 //
1010 mPrivateData.Handle = NULL;
1011 Status = gBS->InstallProtocolInterface (
1012 &mPrivateData.Handle,
1013 &gEfiSmbiosProtocolGuid,
1014 EFI_NATIVE_INTERFACE,
1015 &mPrivateData.Smbios
1016 );
1017
1018 if (EFI_ERROR(Status)) {
1019 return Status;
1020 }
1021 //
1022 // Register the event to install SMBIOS Table into EFI System Table
1023 //
1024 Status = gBS->CreateEventEx (
1025 EVT_NOTIFY_SIGNAL,
1026 TPL_NOTIFY,
1027 SmbiosTableConstruction,
1028 NULL,
1029 &gEfiEventReadyToBootGuid,
1030 &ReadyToBootEvent
1031 );
1032
1033 return Status;
1034 }
EFI Development Kit II mirror for PVE