2 This library will parse the coreboot table in memory and extract those required
5 Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
6 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
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.
16 #include <Uefi/UefiBaseType.h>
17 #include <Library/BaseLib.h>
18 #include <Library/BaseMemoryLib.h>
19 #include <Library/DebugLib.h>
20 #include <Library/PcdLib.h>
21 #include <Library/CbParseLib.h>
23 #include <IndustryStandard/Acpi.h>
29 Convert a packed value from cbuint64 to a UINT64 value.
31 @param val The pointer to packed data.
33 @return the UNIT64 value after convertion.
38 IN
struct cbuint64 val
41 return LShiftU64 (val
.hi
, 32) | val
.lo
;
46 Returns the sum of all elements in a buffer of 16-bit values. During
47 calculation, the carry bits are also been added.
49 @param Buffer The pointer to the buffer to carry out the sum operation.
50 @param Length The size, in bytes, of Buffer.
52 @return Sum The sum of Buffer with carry bits included during additions.
66 TmpPtr
= (UINT8
*)Buffer
;
67 for(Idx
= 0; Idx
< Length
; Idx
++) {
68 TmpValue
= TmpPtr
[Idx
];
77 Sum
= (Sum
+ (Sum
>> 16)) & 0xFFFF;
81 return (UINT16
)((~Sum
) & 0xFFFF);
86 Find coreboot record with given Tag from the memory Start in 4096
89 @param Start The start memory to be searched in
90 @param Tag The tag id to be found
92 @retval NULL The Tag is not found.
93 @retval Others The poiter to the record found.
102 struct cb_header
*Header
;
103 struct cb_record
*Record
;
110 TmpPtr
= (UINT8
*)Start
;
111 for (Idx
= 0; Idx
< 4096; Idx
+= 16, TmpPtr
+= 16) {
112 Header
= (struct cb_header
*)TmpPtr
;
113 if (Header
->signature
== CB_HEADER_SIGNATURE
) {
122 if ((Header
== NULL
) || (Header
->table_bytes
== 0)) {
127 // Check the checksum of the coreboot table header
129 CheckSum
= CbCheckSum16 ((UINT16
*)Header
, sizeof (*Header
));
131 DEBUG ((EFI_D_ERROR
, "Invalid coreboot table header checksum\n"));
135 CheckSum
= CbCheckSum16 ((UINT16
*)(TmpPtr
+ sizeof (*Header
)), Header
->table_bytes
);
136 if (CheckSum
!= Header
->table_checksum
) {
137 DEBUG ((EFI_D_ERROR
, "Incorrect checksum of all the coreboot table entries\n"));
142 TmpPtr
+= Header
->header_bytes
;
143 for (Idx
= 0; Idx
< Header
->table_entries
; Idx
++) {
144 Record
= (struct cb_record
*)TmpPtr
;
145 if (Record
->tag
== CB_TAG_FORWARD
) {
146 TmpPtr
= (VOID
*)(UINTN
)((struct cb_forward
*)(UINTN
)Record
)->forward
;
147 if (Tag
== CB_TAG_FORWARD
) {
150 return FindCbTag (TmpPtr
, Tag
);
153 if (Record
->tag
== Tag
) {
157 TmpPtr
+= Record
->size
;
165 Find the given table with TableId from the given coreboot memory Root.
167 @param Root The coreboot memory table to be searched in
168 @param TableId Table id to be found
169 @param pMemTable To save the base address of the memory table found
170 @param pMemTableSize To save the size of memory table found
172 @retval RETURN_SUCCESS Successfully find out the memory table.
173 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
174 @retval RETURN_NOT_FOUND Failed to find the memory table.
179 IN
struct cbmem_root
*Root
,
181 OUT VOID
**pMemTable
,
182 OUT UINT32
*pMemTableSize
187 struct cbmem_entry
*Entries
;
189 if ((Root
== NULL
) || (pMemTable
== NULL
)) {
190 return RETURN_INVALID_PARAMETER
;
193 // Check if the entry is CBMEM or IMD
194 // and handle them separately
196 Entries
= Root
->entries
;
197 if (Entries
[0].magic
== CBMEM_ENTRY_MAGIC
) {
200 Entries
= (struct cbmem_entry
*)((struct imd_root
*)Root
)->entries
;
201 if (Entries
[0].magic
== IMD_ENTRY_MAGIC
) {
204 return RETURN_NOT_FOUND
;
208 for (Idx
= 0; Idx
< Root
->num_entries
; Idx
++) {
209 if (Entries
[Idx
].id
== TableId
) {
211 *pMemTable
= (VOID
*) ((UINTN
)Entries
[Idx
].start
+ (UINTN
)Root
);
213 *pMemTable
= (VOID
*) (UINTN
)Entries
[Idx
].start
;
215 if (pMemTableSize
!= NULL
) {
216 *pMemTableSize
= Entries
[Idx
].size
;
219 DEBUG ((EFI_D_INFO
, "Find CbMemTable Id 0x%x, base %p, size 0x%x\n",
220 TableId
, *pMemTable
, Entries
[Idx
].size
));
221 return RETURN_SUCCESS
;
225 return RETURN_NOT_FOUND
;
230 Acquire the memory information from the coreboot table in memory.
232 @param MemInfoCallback The callback routine
233 @param pParam Pointer to the callback routine parameter
235 @retval RETURN_SUCCESS Successfully find out the memory information.
236 @retval RETURN_NOT_FOUND Failed to find the memory information.
241 IN CB_MEM_INFO_CALLBACK MemInfoCallback
,
245 struct cb_memory
*rec
;
246 struct cb_memory_range
*Range
;
252 // Get the coreboot memory table
254 rec
= (struct cb_memory
*)FindCbTag (0, CB_TAG_MEMORY
);
256 rec
= (struct cb_memory
*)FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_MEMORY
);
260 return RETURN_NOT_FOUND
;
263 for (Index
= 0; Index
< MEM_RANGE_COUNT(rec
); Index
++) {
264 Range
= MEM_RANGE_PTR(rec
, Index
);
265 Start
= cb_unpack64(Range
->start
);
266 Size
= cb_unpack64(Range
->size
);
267 DEBUG ((EFI_D_INFO
, "%d. %016lx - %016lx [%02x]\n",
268 Index
, Start
, Start
+ Size
- 1, Range
->type
));
270 MemInfoCallback (Start
, Size
, Range
->type
, pParam
);
273 return RETURN_SUCCESS
;
278 Acquire the coreboot memory table with the given table id
280 @param TableId Table id to be searched
281 @param pMemTable Pointer to the base address of the memory table
282 @param pMemTableSize Pointer to the size of the memory table
284 @retval RETURN_SUCCESS Successfully find out the memory table.
285 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
286 @retval RETURN_NOT_FOUND Failed to find the memory table.
292 OUT VOID
**pMemTable
,
293 OUT UINT32
*pMemTableSize
296 struct cb_memory
*rec
;
297 struct cb_memory_range
*Range
;
302 if (pMemTable
== NULL
) {
303 return RETURN_INVALID_PARAMETER
;
308 // Get the coreboot memory table
310 rec
= (struct cb_memory
*)FindCbTag (0, CB_TAG_MEMORY
);
312 rec
= (struct cb_memory
*)FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_MEMORY
);
316 return RETURN_NOT_FOUND
;
319 for (Index
= 0; Index
< MEM_RANGE_COUNT(rec
); Index
++) {
320 Range
= MEM_RANGE_PTR(rec
, Index
);
321 Start
= cb_unpack64(Range
->start
);
322 Size
= cb_unpack64(Range
->size
);
324 if ((Range
->type
== CB_MEM_TABLE
) && (Start
> 0x1000)) {
325 if (FindCbMemTable ((struct cbmem_root
*)(UINTN
)(Start
+ Size
- DYN_CBMEM_ALIGN_SIZE
), TableId
, pMemTable
, pMemTableSize
) == RETURN_SUCCESS
)
326 return RETURN_SUCCESS
;
330 return RETURN_NOT_FOUND
;
335 Acquire the acpi table from coreboot
337 @param pMemTable Pointer to the base address of the memory table
338 @param pMemTableSize Pointer to the size of the memory table
340 @retval RETURN_SUCCESS Successfully find out the memory table.
341 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
342 @retval RETURN_NOT_FOUND Failed to find the memory table.
347 OUT VOID
**pMemTable
,
348 OUT UINT32
*pMemTableSize
351 return CbParseCbMemTable (SIGNATURE_32 ('I', 'P', 'C', 'A'), pMemTable
, pMemTableSize
);
355 Acquire the smbios table from coreboot
357 @param pMemTable Pointer to the base address of the memory table
358 @param pMemTableSize Pointer to the size of the memory table
360 @retval RETURN_SUCCESS Successfully find out the memory table.
361 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
362 @retval RETURN_NOT_FOUND Failed to find the memory table.
367 OUT VOID
**pMemTable
,
368 OUT UINT32
*pMemTableSize
371 return CbParseCbMemTable (SIGNATURE_32 ('T', 'B', 'M', 'S'), pMemTable
, pMemTableSize
);
375 Find the required fadt information
377 @param pPmCtrlReg Pointer to the address of power management control register
378 @param pPmTimerReg Pointer to the address of power management timer register
379 @param pResetReg Pointer to the address of system reset register
380 @param pResetValue Pointer to the value to be writen to the system reset register
381 @param pPmEvtReg Pointer to the address of power management event register
382 @param pPmGpeEnReg Pointer to the address of power management GPE enable register
384 @retval RETURN_SUCCESS Successfully find out all the required fadt information.
385 @retval RETURN_NOT_FOUND Failed to find the fadt table.
390 OUT UINTN
*pPmCtrlReg
,
391 OUT UINTN
*pPmTimerReg
,
392 OUT UINTN
*pResetReg
,
393 OUT UINTN
*pResetValue
,
394 OUT UINTN
*pPmEvtReg
,
395 OUT UINTN
*pPmGpeEnReg
398 EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*Rsdp
;
399 EFI_ACPI_DESCRIPTION_HEADER
*Rsdt
;
402 EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*Fadt
;
403 EFI_ACPI_DESCRIPTION_HEADER
*Xsdt
;
407 RETURN_STATUS Status
;
410 Status
= RETURN_SUCCESS
;
412 Status
= CbParseAcpiTable ((VOID
**)&Rsdp
, NULL
);
413 if (RETURN_ERROR(Status
)) {
418 return RETURN_NOT_FOUND
;
421 DEBUG ((EFI_D_INFO
, "Find Rsdp at %p\n", Rsdp
));
422 DEBUG ((EFI_D_INFO
, "Find Rsdt 0x%x, Xsdt 0x%lx\n", Rsdp
->RsdtAddress
, Rsdp
->XsdtAddress
));
427 Rsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*)(UINTN
)(Rsdp
->RsdtAddress
);
429 Entry32
= (UINT32
*)(Rsdt
+ 1);
430 Entry32Num
= (Rsdt
->Length
- sizeof(EFI_ACPI_DESCRIPTION_HEADER
)) >> 2;
431 for (Idx
= 0; Idx
< Entry32Num
; Idx
++) {
432 if (*(UINT32
*)(UINTN
)(Entry32
[Idx
]) == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
433 Fadt
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*)(UINTN
)(Entry32
[Idx
]);
434 if (pPmCtrlReg
!= NULL
) {
435 *pPmCtrlReg
= Fadt
->Pm1aCntBlk
;
437 DEBUG ((EFI_D_INFO
, "PmCtrl Reg 0x%x\n", Fadt
->Pm1aCntBlk
));
439 if (pPmTimerReg
!= NULL
) {
440 *pPmTimerReg
= Fadt
->PmTmrBlk
;
442 DEBUG ((EFI_D_INFO
, "PmTimer Reg 0x%x\n", Fadt
->PmTmrBlk
));
444 if (pResetReg
!= NULL
) {
445 *pResetReg
= (UINTN
)Fadt
->ResetReg
.Address
;
447 DEBUG ((EFI_D_INFO
, "Reset Reg 0x%lx\n", Fadt
->ResetReg
.Address
));
449 if (pResetValue
!= NULL
) {
450 *pResetValue
= Fadt
->ResetValue
;
452 DEBUG ((EFI_D_INFO
, "Reset Value 0x%x\n", Fadt
->ResetValue
));
454 if (pPmEvtReg
!= NULL
) {
455 *pPmEvtReg
= Fadt
->Pm1aEvtBlk
;
456 DEBUG ((EFI_D_INFO
, "PmEvt Reg 0x%x\n", Fadt
->Pm1aEvtBlk
));
459 if (pPmGpeEnReg
!= NULL
) {
460 *pPmGpeEnReg
= Fadt
->Gpe0Blk
+ Fadt
->Gpe0BlkLen
/ 2;
461 DEBUG ((EFI_D_INFO
, "PmGpeEn Reg 0x%x\n", *pPmGpeEnReg
));
465 // Verify values for proper operation
467 ASSERT(Fadt
->Pm1aCntBlk
!= 0);
468 ASSERT(Fadt
->PmTmrBlk
!= 0);
469 ASSERT(Fadt
->ResetReg
.Address
!= 0);
470 ASSERT(Fadt
->Pm1aEvtBlk
!= 0);
471 ASSERT(Fadt
->Gpe0Blk
!= 0);
473 return RETURN_SUCCESS
;
479 // Search Xsdt Second
481 Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*)(UINTN
)(Rsdp
->XsdtAddress
);
483 Entry64
= (UINT64
*)(Xsdt
+ 1);
484 Entry64Num
= (Xsdt
->Length
- sizeof(EFI_ACPI_DESCRIPTION_HEADER
)) >> 3;
485 for (Idx
= 0; Idx
< Entry64Num
; Idx
++) {
486 if (*(UINT32
*)(UINTN
)(Entry64
[Idx
]) == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
487 Fadt
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*)(UINTN
)(Entry64
[Idx
]);
489 *pPmCtrlReg
= Fadt
->Pm1aCntBlk
;
490 DEBUG ((EFI_D_ERROR
, "PmCtrl Reg 0x%x\n", Fadt
->Pm1aCntBlk
));
493 *pPmTimerReg
= Fadt
->PmTmrBlk
;
494 DEBUG ((EFI_D_ERROR
, "PmTimer Reg 0x%x\n", Fadt
->PmTmrBlk
));
497 *pResetReg
= (UINTN
)Fadt
->ResetReg
.Address
;
498 DEBUG ((EFI_D_ERROR
, "Reset Reg 0x%lx\n", Fadt
->ResetReg
.Address
));
501 *pResetValue
= Fadt
->ResetValue
;
502 DEBUG ((EFI_D_ERROR
, "Reset Value 0x%x\n", Fadt
->ResetValue
));
504 if (pPmEvtReg
!= NULL
) {
505 *pPmEvtReg
= Fadt
->Pm1aEvtBlk
;
506 DEBUG ((EFI_D_INFO
, "PmEvt Reg 0x%x\n", Fadt
->Pm1aEvtBlk
));
509 if (pPmGpeEnReg
!= NULL
) {
510 *pPmGpeEnReg
= Fadt
->Gpe0Blk
+ Fadt
->Gpe0BlkLen
/ 2;
511 DEBUG ((EFI_D_INFO
, "PmGpeEn Reg 0x%x\n", *pPmGpeEnReg
));
513 return RETURN_SUCCESS
;
518 return RETURN_NOT_FOUND
;
522 Find the serial port information
524 @param pRegBase Pointer to the base address of serial port registers
525 @param pRegAccessType Pointer to the access type of serial port registers
526 @param pRegWidth Pointer to the register width in bytes
527 @param pBaudrate Pointer to the serial port baudrate
528 @param pInputHertz Pointer to the input clock frequency
529 @param pUartPciAddr Pointer to the UART PCI bus, dev and func address
531 @retval RETURN_SUCCESS Successfully find the serial port information.
532 @retval RETURN_NOT_FOUND Failed to find the serial port information .
537 OUT UINT32
*pRegBase
,
538 OUT UINT32
*pRegAccessType
,
539 OUT UINT32
*pRegWidth
,
540 OUT UINT32
*pBaudrate
,
541 OUT UINT32
*pInputHertz
,
542 OUT UINT32
*pUartPciAddr
545 struct cb_serial
*CbSerial
;
547 CbSerial
= FindCbTag (0, CB_TAG_SERIAL
);
548 if (CbSerial
== NULL
) {
549 CbSerial
= FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_SERIAL
);
552 if (CbSerial
== NULL
) {
553 return RETURN_NOT_FOUND
;
556 if (pRegBase
!= NULL
) {
557 *pRegBase
= CbSerial
->baseaddr
;
560 if (pRegWidth
!= NULL
) {
561 *pRegWidth
= CbSerial
->regwidth
;
564 if (pRegAccessType
!= NULL
) {
565 *pRegAccessType
= CbSerial
->type
;
568 if (pBaudrate
!= NULL
) {
569 *pBaudrate
= CbSerial
->baud
;
572 if (pInputHertz
!= NULL
) {
573 *pInputHertz
= CbSerial
->input_hertz
;
576 if (pUartPciAddr
!= NULL
) {
577 *pUartPciAddr
= CbSerial
->uart_pci_addr
;
580 return RETURN_SUCCESS
;
584 Search for the coreboot table header
586 @param Level Level of the search depth
587 @param HeaderPtr Pointer to the pointer of coreboot table header
589 @retval RETURN_SUCCESS Successfully find the coreboot table header .
590 @retval RETURN_NOT_FOUND Failed to find the coreboot table header .
602 if (HeaderPtr
== NULL
) {
603 return RETURN_NOT_FOUND
;
607 for (Index
= 0; Index
< Level
; Index
++) {
608 TempPtr
= FindCbTag (TempPtr
, CB_TAG_FORWARD
);
609 if (TempPtr
== NULL
) {
614 if ((Index
>= Level
) && (TempPtr
!= NULL
)) {
615 *HeaderPtr
= TempPtr
;
616 return RETURN_SUCCESS
;
619 return RETURN_NOT_FOUND
;
623 Find the video frame buffer information
625 @param pFbInfo Pointer to the FRAME_BUFFER_INFO structure
627 @retval RETURN_SUCCESS Successfully find the video frame buffer information.
628 @retval RETURN_NOT_FOUND Failed to find the video frame buffer information .
633 OUT FRAME_BUFFER_INFO
*pFbInfo
636 struct cb_framebuffer
*CbFbRec
;
638 if (pFbInfo
== NULL
) {
639 return RETURN_INVALID_PARAMETER
;
642 CbFbRec
= FindCbTag (0, CB_TAG_FRAMEBUFFER
);
643 if (CbFbRec
== NULL
) {
644 CbFbRec
= FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_FRAMEBUFFER
);
647 if (CbFbRec
== NULL
) {
648 return RETURN_NOT_FOUND
;
651 DEBUG ((EFI_D_INFO
, "Found coreboot video frame buffer information\n"));
652 DEBUG ((EFI_D_INFO
, "physical_address: 0x%lx\n", CbFbRec
->physical_address
));
653 DEBUG ((EFI_D_INFO
, "x_resolution: 0x%x\n", CbFbRec
->x_resolution
));
654 DEBUG ((EFI_D_INFO
, "y_resolution: 0x%x\n", CbFbRec
->y_resolution
));
655 DEBUG ((EFI_D_INFO
, "bits_per_pixel: 0x%x\n", CbFbRec
->bits_per_pixel
));
656 DEBUG ((EFI_D_INFO
, "bytes_per_line: 0x%x\n", CbFbRec
->bytes_per_line
));
658 DEBUG ((EFI_D_INFO
, "red_mask_size: 0x%x\n", CbFbRec
->red_mask_size
));
659 DEBUG ((EFI_D_INFO
, "red_mask_pos: 0x%x\n", CbFbRec
->red_mask_pos
));
660 DEBUG ((EFI_D_INFO
, "green_mask_size: 0x%x\n", CbFbRec
->green_mask_size
));
661 DEBUG ((EFI_D_INFO
, "green_mask_pos: 0x%x\n", CbFbRec
->green_mask_pos
));
662 DEBUG ((EFI_D_INFO
, "blue_mask_size: 0x%x\n", CbFbRec
->blue_mask_size
));
663 DEBUG ((EFI_D_INFO
, "blue_mask_pos: 0x%x\n", CbFbRec
->blue_mask_pos
));
664 DEBUG ((EFI_D_INFO
, "reserved_mask_size: 0x%x\n", CbFbRec
->reserved_mask_size
));
665 DEBUG ((EFI_D_INFO
, "reserved_mask_pos: 0x%x\n", CbFbRec
->reserved_mask_pos
));
667 pFbInfo
->LinearFrameBuffer
= CbFbRec
->physical_address
;
668 pFbInfo
->HorizontalResolution
= CbFbRec
->x_resolution
;
669 pFbInfo
->VerticalResolution
= CbFbRec
->y_resolution
;
670 pFbInfo
->BitsPerPixel
= CbFbRec
->bits_per_pixel
;
671 pFbInfo
->BytesPerScanLine
= (UINT16
)CbFbRec
->bytes_per_line
;
672 pFbInfo
->Red
.Mask
= (1 << CbFbRec
->red_mask_size
) - 1;
673 pFbInfo
->Red
.Position
= CbFbRec
->red_mask_pos
;
674 pFbInfo
->Green
.Mask
= (1 << CbFbRec
->green_mask_size
) - 1;
675 pFbInfo
->Green
.Position
= CbFbRec
->green_mask_pos
;
676 pFbInfo
->Blue
.Mask
= (1 << CbFbRec
->blue_mask_size
) - 1;
677 pFbInfo
->Blue
.Position
= CbFbRec
->blue_mask_pos
;
678 pFbInfo
->Reserved
.Mask
= (1 << CbFbRec
->reserved_mask_size
) - 1;
679 pFbInfo
->Reserved
.Position
= CbFbRec
->reserved_mask_pos
;
681 return RETURN_SUCCESS
;