2 This library will parse the coreboot table in memory and extract those required
5 Copyright (c) 2014, 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 static UINT64
cb_unpack64(struct cbuint64 val
)
31 return LShiftU64 (val
.hi
, 32) | val
.lo
;
45 TmpPtr
= (UINT8
*)Buffer
;
46 for(Idx
= 0; Idx
< Length
; Idx
++) {
47 TmpValue
= TmpPtr
[Idx
];
56 Sum
= (Sum
+ (Sum
>> 16)) & 0xFFFF;
60 return (UINT16
)((~Sum
) & 0xFFFF);
69 struct cb_header
*Header
;
70 struct cb_record
*Record
;
77 TmpPtr
= (UINT8
*)Start
;
78 for (Idx
= 0; Idx
< 4096; Idx
+= 16, TmpPtr
+= 16) {
79 Header
= (struct cb_header
*)TmpPtr
;
80 if (Header
->signature
== CB_HEADER_SIGNATURE
) {
88 if (Header
== NULL
|| !Header
->table_bytes
)
92 // Check the checksum of the coreboot table header
94 CheckSum
= CbCheckSum16 ((UINT16
*)Header
, sizeof (*Header
));
96 DEBUG ((EFI_D_ERROR
, "Invalid coreboot table header checksum\n"));
100 CheckSum
= CbCheckSum16 ((UINT16
*)(TmpPtr
+ sizeof (*Header
)), Header
->table_bytes
);
101 if (CheckSum
!= Header
->table_checksum
) {
102 DEBUG ((EFI_D_ERROR
, "Incorrect checksum of all the coreboot table entries\n"));
107 TmpPtr
+= Header
->header_bytes
;
108 for (Idx
= 0; Idx
< Header
->table_entries
; Idx
++) {
109 Record
= (struct cb_record
*)TmpPtr
;
110 if (Record
->tag
== CB_TAG_FORWARD
) {
111 TmpPtr
= (VOID
*)(UINTN
)((struct cb_forward
*)(UINTN
)Record
)->forward
;
112 if (Tag
== CB_TAG_FORWARD
)
115 return FindCbTag (TmpPtr
, Tag
);
117 if (Record
->tag
== Tag
) {
121 TmpPtr
+= Record
->size
;
129 struct cbmem_root
*root
,
132 IN UINT32
* pMemTableSize
137 if ((!root
) || (!pMemTable
))
138 return RETURN_INVALID_PARAMETER
;
140 for (Idx
= 0; Idx
< root
->num_entries
; Idx
++) {
141 if (root
->entries
[Idx
].id
== TableId
) {
142 *pMemTable
= (VOID
*) (UINTN
)root
->entries
[Idx
].start
;
144 *pMemTableSize
= root
->entries
[Idx
].size
;
146 DEBUG ((EFI_D_ERROR
, "Find CbMemTable Id 0x%x, base %p, size 0x%x\n", TableId
, *pMemTable
, *pMemTableSize
));
147 return RETURN_SUCCESS
;
151 return RETURN_NOT_FOUND
;
156 Acquire the memory information from the coreboot table in memory.
158 @param pLowMemorySize Pointer to the variable of low memory size
159 @param pHighMemorySize Pointer to the variable of high memory size
161 @retval RETURN_SUCCESS Successfully find out the memory information.
162 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
163 @retval RETURN_NOT_FOUND Failed to find the memory information.
168 IN UINT64
* pLowMemorySize
,
169 IN UINT64
* pHighMemorySize
172 struct cb_memory
* rec
;
173 struct cb_memory_range
* Range
;
178 if ((!pLowMemorySize
) || (!pHighMemorySize
))
179 return RETURN_INVALID_PARAMETER
;
182 // Get the coreboot memory table
184 rec
= (struct cb_memory
*)FindCbTag (0, CB_TAG_MEMORY
);
186 rec
= (struct cb_memory
*)FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_MEMORY
);
189 return RETURN_NOT_FOUND
;
192 *pHighMemorySize
= 0;
194 for (Index
= 0; Index
< MEM_RANGE_COUNT(rec
); Index
++) {
195 Range
= MEM_RANGE_PTR(rec
, Index
);
196 Start
= cb_unpack64(Range
->start
);
197 Size
= cb_unpack64(Range
->size
);
198 DEBUG ((EFI_D_ERROR
, "%d. %016lx - %016lx [%02x]\n",
199 Index
, Start
, Start
+ Size
- 1, Range
->type
));
201 if (Range
->type
!= CB_MEM_RAM
) {
205 if (Start
+ Size
< 0x100000000ULL
) {
206 *pLowMemorySize
= Start
+ Size
;
208 *pHighMemorySize
= Start
+ Size
- 0x100000000ULL
;
212 DEBUG ((EFI_D_ERROR
, "Low memory 0x%lx, High Memory 0x%lx\n", *pLowMemorySize
, *pHighMemorySize
));
214 return RETURN_SUCCESS
;
219 Acquire the coreboot memory table with the given table id
221 @param TableId Table id to be searched
222 @param pMemTable Pointer to the base address of the memory table
223 @param pMemTableSize Pointer to the size of the memory table
225 @retval RETURN_SUCCESS Successfully find out the memory table.
226 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
227 @retval RETURN_NOT_FOUND Failed to find the memory table.
234 IN UINT32
* pMemTableSize
237 struct cb_memory
* rec
;
238 struct cb_memory_range
* Range
;
244 return RETURN_INVALID_PARAMETER
;
249 // Get the coreboot memory table
251 rec
= (struct cb_memory
*)FindCbTag (0, CB_TAG_MEMORY
);
253 rec
= (struct cb_memory
*)FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_MEMORY
);
256 return RETURN_NOT_FOUND
;
258 for (Index
= 0; Index
< MEM_RANGE_COUNT(rec
); Index
++) {
259 Range
= MEM_RANGE_PTR(rec
, Index
);
260 Start
= cb_unpack64(Range
->start
);
261 Size
= cb_unpack64(Range
->size
);
263 if ((Range
->type
== CB_MEM_TABLE
) && (Start
> 0x1000)) {
264 if (FindCbMemTable ((struct cbmem_root
*)(UINTN
)(Start
+ Size
- DYN_CBMEM_ALIGN_SIZE
), TableId
, pMemTable
, pMemTableSize
) == RETURN_SUCCESS
)
265 return RETURN_SUCCESS
;
269 return RETURN_NOT_FOUND
;
274 Acquire the acpi table from coreboot
276 @param pMemTable Pointer to the base address of the memory table
277 @param pMemTableSize Pointer to the size of the memory table
279 @retval RETURN_SUCCESS Successfully find out the memory table.
280 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
281 @retval RETURN_NOT_FOUND Failed to find the memory table.
287 IN UINT32
* pMemTableSize
290 return CbParseCbMemTable (SIGNATURE_32 ('I', 'P', 'C', 'A'), (VOID
**)pMemTable
, pMemTableSize
);
294 Acquire the smbios table from coreboot
296 @param pMemTable Pointer to the base address of the memory table
297 @param pMemTableSize Pointer to the size of the memory table
299 @retval RETURN_SUCCESS Successfully find out the memory table.
300 @retval RETURN_INVALID_PARAMETER Invalid input parameters.
301 @retval RETURN_NOT_FOUND Failed to find the memory table.
307 IN UINT32
* pMemTableSize
310 return CbParseCbMemTable (SIGNATURE_32 ('T', 'B', 'M', 'S'), pMemTable
, pMemTableSize
);
314 Find the required fadt information
316 @param pPmCtrlReg Pointer to the address of power management control register
317 @param pPmTimerReg Pointer to the address of power management timer register
318 @param pResetReg Pointer to the address of system reset register
319 @param pResetValue Pointer to the value to be writen to the system reset register
321 @retval RETURN_SUCCESS Successfully find out all the required fadt information.
322 @retval RETURN_NOT_FOUND Failed to find the fadt table.
327 IN UINTN
* pPmCtrlReg
,
328 IN UINTN
* pPmTimerReg
,
330 IN UINTN
* pResetValue
333 EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
* Rsdp
;
334 EFI_ACPI_DESCRIPTION_HEADER
* Rsdt
;
337 EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
* Fadt
;
338 EFI_ACPI_DESCRIPTION_HEADER
* Xsdt
;
342 RETURN_STATUS Status
;
345 Status
= RETURN_SUCCESS
;
347 Status
= CbParseAcpiTable (&Rsdp
, NULL
);
348 if (RETURN_ERROR(Status
))
352 return RETURN_NOT_FOUND
;
354 DEBUG ((EFI_D_ERROR
, "Find Rsdp at %p\n", Rsdp
));
355 DEBUG ((EFI_D_ERROR
, "Find Rsdt 0x%x, Xsdt 0x%lx\n", Rsdp
->RsdtAddress
, Rsdp
->XsdtAddress
));
360 Rsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*)(UINTN
)(Rsdp
->RsdtAddress
);
362 Entry32
= (UINT32
*)(Rsdt
+ 1);
363 Entry32Num
= (Rsdt
->Length
- sizeof(EFI_ACPI_DESCRIPTION_HEADER
)) >> 2;
364 for (Idx
= 0; Idx
< Entry32Num
; Idx
++) {
365 if (*(UINT32
*)(UINTN
)(Entry32
[Idx
]) == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
366 Fadt
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*)(UINTN
)(Entry32
[Idx
]);
368 *pPmCtrlReg
= Fadt
->Pm1aCntBlk
;
369 DEBUG ((EFI_D_ERROR
, "PmCtrl Reg 0x%x\n", Fadt
->Pm1aCntBlk
));
372 *pPmTimerReg
= Fadt
->PmTmrBlk
;
373 DEBUG ((EFI_D_ERROR
, "PmTimer Reg 0x%x\n", Fadt
->PmTmrBlk
));
376 *pResetReg
= (UINTN
)Fadt
->ResetReg
.Address
;
377 DEBUG ((EFI_D_ERROR
, "Reset Reg 0x%lx\n", Fadt
->ResetReg
.Address
));
380 *pResetValue
= Fadt
->ResetValue
;
381 DEBUG ((EFI_D_ERROR
, "Reset Value 0x%x\n", Fadt
->ResetValue
));
383 return RETURN_SUCCESS
;
389 // Search Xsdt Second
391 Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*)(UINTN
)(Rsdp
->XsdtAddress
);
393 Entry64
= (UINT64
*)(Xsdt
+ 1);
394 Entry64Num
= (Xsdt
->Length
- sizeof(EFI_ACPI_DESCRIPTION_HEADER
)) >> 3;
395 for (Idx
= 0; Idx
< Entry64Num
; Idx
++) {
396 if (*(UINT32
*)(UINTN
)(Entry64
[Idx
]) == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
397 Fadt
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*)(UINTN
)(Entry64
[Idx
]);
399 *pPmCtrlReg
= Fadt
->Pm1aCntBlk
;
400 DEBUG ((EFI_D_ERROR
, "PmCtrl Reg 0x%x\n", Fadt
->Pm1aCntBlk
));
403 *pPmTimerReg
= Fadt
->PmTmrBlk
;
404 DEBUG ((EFI_D_ERROR
, "PmTimer Reg 0x%x\n", Fadt
->PmTmrBlk
));
407 *pResetReg
= (UINTN
)Fadt
->ResetReg
.Address
;
408 DEBUG ((EFI_D_ERROR
, "Reset Reg 0x%lx\n", Fadt
->ResetReg
.Address
));
411 *pResetValue
= Fadt
->ResetValue
;
412 DEBUG ((EFI_D_ERROR
, "Reset Value 0x%x\n", Fadt
->ResetValue
));
414 return RETURN_SUCCESS
;
419 return RETURN_NOT_FOUND
;
423 Find the serial port information
425 @param pRegBase Pointer to the base address of serial port registers
426 @param pRegAccessType Pointer to the access type of serial port registers
427 @param pBaudrate Pointer to the serial port baudrate
429 @retval RETURN_SUCCESS Successfully find the serial port information.
430 @retval RETURN_NOT_FOUND Failed to find the serial port information .
436 IN UINT32
* pRegAccessType
,
440 struct cb_serial
* CbSerial
;
442 CbSerial
= FindCbTag (0, CB_TAG_SERIAL
);
444 CbSerial
= FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_SERIAL
);
447 return RETURN_NOT_FOUND
;
450 *pRegBase
= CbSerial
->baseaddr
;
453 *pRegAccessType
= CbSerial
->type
;
456 *pBaudrate
= CbSerial
->baud
;
458 return RETURN_SUCCESS
;
462 Search for the coreboot table header
464 @param Level Level of the search depth
465 @param HeaderPtr Pointer to the pointer of coreboot table header
467 @retval RETURN_SUCCESS Successfully find the coreboot table header .
468 @retval RETURN_NOT_FOUND Failed to find the coreboot table header .
481 return RETURN_NOT_FOUND
;
484 for (Index
= 0; Index
< Level
; Index
++) {
485 TempPtr
= FindCbTag (TempPtr
, CB_TAG_FORWARD
);
490 if ((Index
>= Level
) && (TempPtr
!= NULL
)) {
491 *HeaderPtr
= TempPtr
;
492 return RETURN_SUCCESS
;
495 return RETURN_NOT_FOUND
;
499 Find the video frame buffer information
501 @param pFbInfo Pointer to the FRAME_BUFFER_INFO structure
503 @retval RETURN_SUCCESS Successfully find the video frame buffer information.
504 @retval RETURN_NOT_FOUND Failed to find the video frame buffer information .
509 IN FRAME_BUFFER_INFO
* pFbInfo
512 struct cb_framebuffer
* CbFbRec
;
515 return RETURN_INVALID_PARAMETER
;
517 CbFbRec
= FindCbTag (0, CB_TAG_FRAMEBUFFER
);
519 CbFbRec
= FindCbTag ((VOID
*)(UINTN
)PcdGet32 (PcdCbHeaderPointer
), CB_TAG_FRAMEBUFFER
);
522 return RETURN_NOT_FOUND
;
524 DEBUG ((EFI_D_ERROR
, "Found coreboot video frame buffer information\n"));
525 DEBUG ((EFI_D_ERROR
, "physical_address: 0x%lx\n", CbFbRec
->physical_address
));
526 DEBUG ((EFI_D_ERROR
, "x_resolution: 0x%x\n", CbFbRec
->x_resolution
));
527 DEBUG ((EFI_D_ERROR
, "y_resolution: 0x%x\n", CbFbRec
->y_resolution
));
528 DEBUG ((EFI_D_ERROR
, "bits_per_pixel: 0x%x\n", CbFbRec
->bits_per_pixel
));
529 DEBUG ((EFI_D_ERROR
, "bytes_per_line: 0x%x\n", CbFbRec
->bytes_per_line
));
531 DEBUG ((EFI_D_ERROR
, "red_mask_size: 0x%x\n", CbFbRec
->red_mask_size
));
532 DEBUG ((EFI_D_ERROR
, "red_mask_pos: 0x%x\n", CbFbRec
->red_mask_pos
));
533 DEBUG ((EFI_D_ERROR
, "green_mask_size: 0x%x\n", CbFbRec
->green_mask_size
));
534 DEBUG ((EFI_D_ERROR
, "green_mask_pos: 0x%x\n", CbFbRec
->green_mask_pos
));
535 DEBUG ((EFI_D_ERROR
, "blue_mask_size: 0x%x\n", CbFbRec
->blue_mask_size
));
536 DEBUG ((EFI_D_ERROR
, "blue_mask_pos: 0x%x\n", CbFbRec
->blue_mask_pos
));
537 DEBUG ((EFI_D_ERROR
, "reserved_mask_size: 0x%x\n", CbFbRec
->reserved_mask_size
));
538 DEBUG ((EFI_D_ERROR
, "reserved_mask_pos: 0x%x\n", CbFbRec
->reserved_mask_pos
));
540 pFbInfo
->LinearFrameBuffer
= CbFbRec
->physical_address
;
541 pFbInfo
->HorizontalResolution
= CbFbRec
->x_resolution
;
542 pFbInfo
->VerticalResolution
= CbFbRec
->y_resolution
;
543 pFbInfo
->BitsPerPixel
= CbFbRec
->bits_per_pixel
;
544 pFbInfo
->BytesPerScanLine
= (UINT16
)CbFbRec
->bytes_per_line
;
545 pFbInfo
->Red
.Mask
= (1 << CbFbRec
->red_mask_size
) - 1;
546 pFbInfo
->Red
.Position
= CbFbRec
->red_mask_pos
;
547 pFbInfo
->Green
.Mask
= (1 << CbFbRec
->green_mask_size
) - 1;
548 pFbInfo
->Green
.Position
= CbFbRec
->green_mask_pos
;
549 pFbInfo
->Blue
.Mask
= (1 << CbFbRec
->blue_mask_size
) - 1;
550 pFbInfo
->Blue
.Position
= CbFbRec
->blue_mask_pos
;
551 pFbInfo
->Reserved
.Mask
= (1 << CbFbRec
->reserved_mask_size
) - 1;
552 pFbInfo
->Reserved
.Position
= CbFbRec
->reserved_mask_pos
;
554 return RETURN_SUCCESS
;