summaryrefslogtreecommitdiffstats
path: root/CorebootModulePkg/Library/CbParseLib/CbParseLib.c
blob: c9b39b1de3f5c58fb3b722e000b4b167737053b7 (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
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
/** @file
  This library will parse the coreboot table in memory and extract those required
  information.

  Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
  This program and the accompanying materials
  are licensed and made available under the terms and conditions of the BSD License
  which accompanies this distribution.  The full text of the license may be found at
  http://opensource.org/licenses/bsd-license.php

  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/

#include <Uefi/UefiBaseType.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <Library/CbParseLib.h>

#include <IndustryStandard/Acpi.h>

#include "Coreboot.h"

/* Helpful inlines */

static UINT64 cb_unpack64(struct cbuint64 val)
{
  return LShiftU64 (val.hi, 32) | val.lo;
}

UINT16
CbCheckSum16 (
  IN UINT16   *Buffer,
  IN UINTN    Length
  )
{
	UINT32 Sum, TmpValue;
	UINTN  Idx;
	UINT8  *TmpPtr;
	
	Sum = 0;
	TmpPtr = (UINT8 *)Buffer;
	for(Idx = 0; Idx < Length; Idx++) {
		TmpValue  = TmpPtr[Idx];
		if (Idx % 2 == 1) {
			TmpValue <<= 8;
		}
		
		Sum += TmpValue;
		
		// Wrap
		if (Sum >= 0x10000) {
			Sum = (Sum + (Sum >> 16)) & 0xFFFF;
		}
	}
	
	return (UINT16)((~Sum) & 0xFFFF);		
}

VOID *
FindCbTag (
  IN  VOID    *Start,
  IN  UINT32   Tag
  )
{
  struct cb_header   *Header;
  struct cb_record   *Record;
  UINT8              *TmpPtr;  
  UINT8              *TagPtr;  
  UINTN              Idx;  
  UINT16             CheckSum;
      
  Header = NULL;
  TmpPtr = (UINT8 *)Start;
  for (Idx = 0; Idx < 4096; Idx += 16, TmpPtr += 16) {
    Header = (struct cb_header   *)TmpPtr;
    if (Header->signature == CB_HEADER_SIGNATURE) {
      break;
    }
  }
  
  if (Idx >= 4096)
  	return NULL;
  
  if (Header == NULL || !Header->table_bytes)
    return NULL;
    
  //
  // Check the checksum of the coreboot table header
  //
  CheckSum = CbCheckSum16 ((UINT16 *)Header, sizeof (*Header));
  if (CheckSum != 0) {
  	DEBUG ((EFI_D_ERROR, "Invalid coreboot table header checksum\n"));
  	return NULL;
  }  
  
  CheckSum = CbCheckSum16 ((UINT16 *)(TmpPtr + sizeof (*Header)), Header->table_bytes);
  if (CheckSum != Header->table_checksum) {
  	DEBUG ((EFI_D_ERROR, "Incorrect checksum of all the coreboot table entries\n"));
  	return NULL;
  }
     
  TagPtr = NULL;
  TmpPtr += Header->header_bytes;
  for (Idx = 0; Idx < Header->table_entries; Idx++) {
    Record = (struct cb_record *)TmpPtr;        
    if (Record->tag == CB_TAG_FORWARD) {
      TmpPtr = (VOID *)(UINTN)((struct cb_forward *)(UINTN)Record)->forward;
      if (Tag == CB_TAG_FORWARD)
        return TmpPtr;
      else 
        return FindCbTag (TmpPtr, Tag);
    }       
    if (Record->tag == Tag) {
      TagPtr = TmpPtr;
      break;
    }
    TmpPtr += Record->size;    
  }
    
  return TagPtr;
}

RETURN_STATUS
FindCbMemTable (  
  struct  cbmem_root  *root,
  IN UINT32     TableId, 
  IN VOID**     pMemTable,
  IN UINT32*    pMemTableSize
)
{	
	UINTN Idx;
	
	if ((!root) || (!pMemTable))
		return RETURN_INVALID_PARAMETER;
		
	for (Idx = 0; Idx < root->num_entries; Idx++) {
    if (root->entries[Idx].id == TableId) {
    	*pMemTable = (VOID *) (UINTN)root->entries[Idx].start;
    	if (pMemTableSize)
    		*pMemTableSize = root->entries[Idx].size;
    	
    	DEBUG ((EFI_D_ERROR, "Find CbMemTable Id 0x%x, base %p, size 0x%x\n", TableId, *pMemTable, *pMemTableSize));
    	return RETURN_SUCCESS;
    }
  }
  
  return RETURN_NOT_FOUND;	
}


/**
  Acquire the memory information from the coreboot table in memory.

  @param  pLowMemorySize     Pointer to the variable of low memory size
  @param  pHighMemorySize    Pointer to the variable of high memory size

  @retval RETURN_SUCCESS     Successfully find out the memory information.
  @retval RETURN_INVALID_PARAMETER    Invalid input parameters.
  @retval RETURN_NOT_FOUND   Failed to find the memory information.

**/
RETURN_STATUS
CbParseMemoryInfo (
  IN UINT64*    pLowMemorySize,
  IN UINT64*    pHighMemorySize
  )
{
	struct cb_memory*        rec;
	struct cb_memory_range*  Range;
  UINT64                   Start;
  UINT64                   Size;
	UINTN                    Index;
	
	if ((!pLowMemorySize) || (!pHighMemorySize))
		return RETURN_INVALID_PARAMETER;
	
	//
	// Get the coreboot memory table
	//
	rec = (struct cb_memory *)FindCbTag (0, CB_TAG_MEMORY);
	if (!rec) 
	  rec = (struct cb_memory *)FindCbTag ((VOID *)(UINTN)PcdGet32 (PcdCbHeaderPointer), CB_TAG_MEMORY);
		
	if (!rec) 
		return RETURN_NOT_FOUND;
		
	*pLowMemorySize = 0;
	*pHighMemorySize = 0;
		
	for (Index = 0; Index < MEM_RANGE_COUNT(rec); Index++) {
    Range = MEM_RANGE_PTR(rec, Index);    
    Start = cb_unpack64(Range->start);
    Size = cb_unpack64(Range->size);
    DEBUG ((EFI_D_ERROR, "%d. %016lx - %016lx [%02x]\n",
      Index, Start, Start + Size - 1, Range->type));
    
    if (Range->type != CB_MEM_RAM) {
      continue;
    }
      
    if (Start + Size < 0x100000000ULL) {
      *pLowMemorySize = Start + Size;
    } else {      
      *pHighMemorySize = Start + Size - 0x100000000ULL;
    }
  }
  
  DEBUG ((EFI_D_ERROR, "Low memory 0x%lx, High Memory 0x%lx\n", *pLowMemorySize, *pHighMemorySize));
  
  return RETURN_SUCCESS;	
}


/**
  Acquire the coreboot memory table with the given table id

  @param  TableId            Table id to be searched
  @param  pMemTable          Pointer to the base address of the memory table
  @param  pMemTableSize      Pointer to the size of the memory table

  @retval RETURN_SUCCESS     Successfully find out the memory table.
  @retval RETURN_INVALID_PARAMETER  Invalid input parameters.
  @retval RETURN_NOT_FOUND   Failed to find the memory table.

**/
RETURN_STATUS
CbParseCbMemTable (
  IN UINT32     TableId, 
  IN VOID**     pMemTable,
  IN UINT32*    pMemTableSize
  )
{
	struct cb_memory*        rec;
	struct cb_memory_range*  Range;
  UINT64                   Start;
  UINT64                   Size;
	UINTN                    Index;
	
	if (!pMemTable)
		return RETURN_INVALID_PARAMETER;
		
	*pMemTable = NULL;
	
	//
	// Get the coreboot memory table
	//
	rec = (struct cb_memory *)FindCbTag (0, CB_TAG_MEMORY);
	if (!rec)
		rec = (struct cb_memory *)FindCbTag ((VOID *)(UINTN)PcdGet32 (PcdCbHeaderPointer), CB_TAG_MEMORY);
		
	if (!rec)
		return RETURN_NOT_FOUND;
		
	for (Index = 0; Index < MEM_RANGE_COUNT(rec); Index++) {
    Range = MEM_RANGE_PTR(rec, Index);    
    Start = cb_unpack64(Range->start);
    Size = cb_unpack64(Range->size);
    
    if ((Range->type == CB_MEM_TABLE) && (Start > 0x1000)) {
        if (FindCbMemTable ((struct  cbmem_root *)(UINTN)(Start + Size - DYN_CBMEM_ALIGN_SIZE), TableId, pMemTable, pMemTableSize) == RETURN_SUCCESS)
        	return RETURN_SUCCESS;
    }
  }
	
	return RETURN_NOT_FOUND;
}


/**
  Acquire the acpi table from coreboot

  @param  pMemTable          Pointer to the base address of the memory table
  @param  pMemTableSize      Pointer to the size of the memory table

  @retval RETURN_SUCCESS     Successfully find out the memory table.
  @retval RETURN_INVALID_PARAMETER  Invalid input parameters.
  @retval RETURN_NOT_FOUND   Failed to find the memory table.

**/
RETURN_STATUS
CbParseAcpiTable (
  IN VOID*      pMemTable,
  IN UINT32*    pMemTableSize
  )
{
	return CbParseCbMemTable (SIGNATURE_32 ('I', 'P', 'C', 'A'), (VOID **)pMemTable, pMemTableSize);	
}

/**
  Acquire the smbios table from coreboot

  @param  pMemTable          Pointer to the base address of the memory table
  @param  pMemTableSize      Pointer to the size of the memory table

  @retval RETURN_SUCCESS     Successfully find out the memory table.
  @retval RETURN_INVALID_PARAMETER  Invalid input parameters.
  @retval RETURN_NOT_FOUND   Failed to find the memory table.

**/
RETURN_STATUS
CbParseSmbiosTable (
  IN VOID**     pMemTable,
  IN UINT32*    pMemTableSize
  )
{
	return CbParseCbMemTable (SIGNATURE_32 ('T', 'B', 'M', 'S'), pMemTable, pMemTableSize);	
}

/**
  Find the required fadt information

  @param  pPmCtrlReg         Pointer to the address of power management control register
  @param  pPmTimerReg        Pointer to the address of power management timer register
  @param  pResetReg          Pointer to the address of system reset register
  @param  pResetValue        Pointer to the value to be writen to the system reset register

  @retval RETURN_SUCCESS     Successfully find out all the required fadt information.
  @retval RETURN_NOT_FOUND   Failed to find the fadt table.

**/
RETURN_STATUS
CbParseFadtInfo (
  IN UINTN*     pPmCtrlReg,
  IN UINTN*     pPmTimerReg,
  IN UINTN*     pResetReg,
  IN UINTN*     pResetValue
  )
{
	EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER* Rsdp;
	EFI_ACPI_DESCRIPTION_HEADER*                  Rsdt;
  UINT32*                                       Entry32;
  UINTN                                         Entry32Num;
  EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE*    Fadt;
  EFI_ACPI_DESCRIPTION_HEADER*                  Xsdt; 
  UINT64*                                       Entry64;
  UINTN                                         Entry64Num;
	UINTN                                         Idx;
	RETURN_STATUS                                 Status;
	
	Rsdp = NULL;
	Status = RETURN_SUCCESS;
	
	Status = CbParseAcpiTable (&Rsdp, NULL);
	if (RETURN_ERROR(Status))
		return Status;
		
	if (!Rsdp)
		return RETURN_NOT_FOUND;
		
	DEBUG ((EFI_D_ERROR, "Find Rsdp at %p\n", Rsdp));
	DEBUG ((EFI_D_ERROR, "Find Rsdt 0x%x, Xsdt 0x%lx\n", Rsdp->RsdtAddress, Rsdp->XsdtAddress));
	
	//
	// Search Rsdt First
	//
	Rsdt     = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)(Rsdp->RsdtAddress);  
	if (Rsdt != NULL) {
	  Entry32  = (UINT32 *)(Rsdt + 1);
	  Entry32Num = (Rsdt->Length - sizeof(EFI_ACPI_DESCRIPTION_HEADER)) >> 2;
	  for (Idx = 0; Idx < Entry32Num; Idx++) {
	    if (*(UINT32 *)(UINTN)(Entry32[Idx]) == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {
	      Fadt = (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)(UINTN)(Entry32[Idx]);  
	      if (pPmCtrlReg)
	      	*pPmCtrlReg = Fadt->Pm1aCntBlk;	      	
	      DEBUG ((EFI_D_ERROR, "PmCtrl Reg 0x%x\n", Fadt->Pm1aCntBlk));
	      	
	      if (pPmTimerReg)   
	      	*pPmTimerReg = Fadt->PmTmrBlk; 
	      DEBUG ((EFI_D_ERROR, "PmTimer Reg 0x%x\n", Fadt->PmTmrBlk));
	      	
	      if (pResetReg)   
	      	*pResetReg = (UINTN)Fadt->ResetReg.Address; 
	      DEBUG ((EFI_D_ERROR, "Reset Reg 0x%lx\n", Fadt->ResetReg.Address));
	      	
	      if (pResetValue)   
	      	*pResetValue = Fadt->ResetValue;
	      DEBUG ((EFI_D_ERROR, "Reset Value 0x%x\n", Fadt->ResetValue));
	      	      	         
	      return RETURN_SUCCESS;        
	    }
	  }
	}
	
	//
	// Search Xsdt Second
	//
	Xsdt     = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)(Rsdp->XsdtAddress);  
	if (Xsdt != NULL) {
	  Entry64  = (UINT64 *)(Xsdt + 1);
	  Entry64Num = (Xsdt->Length - sizeof(EFI_ACPI_DESCRIPTION_HEADER)) >> 3;
	  for (Idx = 0; Idx < Entry64Num; Idx++) {
	    if (*(UINT32 *)(UINTN)(Entry64[Idx]) == EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {
	      Fadt = (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *)(UINTN)(Entry64[Idx]);  
	      if (pPmCtrlReg)
	      	*pPmCtrlReg = Fadt->Pm1aCntBlk;	      	
	      DEBUG ((EFI_D_ERROR, "PmCtrl Reg 0x%x\n", Fadt->Pm1aCntBlk));
	      	
	      if (pPmTimerReg)   
	      	*pPmTimerReg = Fadt->PmTmrBlk; 
	      DEBUG ((EFI_D_ERROR, "PmTimer Reg 0x%x\n", Fadt->PmTmrBlk));
	      	
	      if (pResetReg)   
	      	*pResetReg = (UINTN)Fadt->ResetReg.Address; 
	      DEBUG ((EFI_D_ERROR, "Reset Reg 0x%lx\n", Fadt->ResetReg.Address));
	      	
	      if (pResetValue)   
	      	*pResetValue = Fadt->ResetValue;
	      DEBUG ((EFI_D_ERROR, "Reset Value 0x%x\n", Fadt->ResetValue));
	      	      	         
	      return RETURN_SUCCESS;        
	    }
	  }
	}	
	
	return RETURN_NOT_FOUND;
}

/**
  Find the serial port information

  @param  pRegBase           Pointer to the base address of serial port registers
  @param  pRegAccessType     Pointer to the access type of serial port registers
  @param  pBaudrate          Pointer to the serial port baudrate

  @retval RETURN_SUCCESS     Successfully find the serial port information.
  @retval RETURN_NOT_FOUND   Failed to find the serial port information .

**/
RETURN_STATUS
CbParseSerialInfo (
  IN UINT32*     pRegBase,
  IN UINT32*     pRegAccessType,
  IN UINT32*     pBaudrate
  )
{
	struct cb_serial*   CbSerial;
	
	CbSerial = FindCbTag (0, CB_TAG_SERIAL);
	if (!CbSerial)
		CbSerial = FindCbTag ((VOID *)(UINTN)PcdGet32 (PcdCbHeaderPointer), CB_TAG_SERIAL);
	
	if (!CbSerial)
		return RETURN_NOT_FOUND;
		
	if (pRegBase)
		*pRegBase = CbSerial->baseaddr;
		
	if (pRegAccessType)
		*pRegAccessType = CbSerial->type;
		
	if (pBaudrate)
		*pBaudrate = CbSerial->baud;
			
	return RETURN_SUCCESS;
}

/**
  Search for the coreboot table header

  @param  Level              Level of the search depth
  @param  HeaderPtr          Pointer to the pointer of coreboot table header

  @retval RETURN_SUCCESS     Successfully find the coreboot table header .
  @retval RETURN_NOT_FOUND   Failed to find the coreboot table header .

**/
RETURN_STATUS
CbParseGetCbHeader (
  IN UINTN  Level,
  IN VOID** HeaderPtr
  )
{
	UINTN Index;
	VOID* TempPtr;
	
	if (!HeaderPtr)
		return RETURN_NOT_FOUND;
	
	TempPtr = NULL;	
	for (Index = 0; Index < Level; Index++) {
		TempPtr = FindCbTag (TempPtr, CB_TAG_FORWARD);
		if (!TempPtr)
			break;		
	}
	
	if ((Index >= Level) && (TempPtr != NULL)) {
		*HeaderPtr = TempPtr;
		return RETURN_SUCCESS;
	}
	
	return RETURN_NOT_FOUND;
}

/**
  Find the video frame buffer information

  @param  pFbInfo            Pointer to the FRAME_BUFFER_INFO structure

  @retval RETURN_SUCCESS     Successfully find the video frame buffer information.
  @retval RETURN_NOT_FOUND   Failed to find the video frame buffer information .

**/
RETURN_STATUS
CbParseFbInfo (
  IN FRAME_BUFFER_INFO*     pFbInfo
  )
{
	struct cb_framebuffer*   CbFbRec;
	
	if (!pFbInfo)
		return RETURN_INVALID_PARAMETER;
	
	CbFbRec = FindCbTag (0, CB_TAG_FRAMEBUFFER);
	if (!CbFbRec)
		CbFbRec = FindCbTag ((VOID *)(UINTN)PcdGet32 (PcdCbHeaderPointer), CB_TAG_FRAMEBUFFER);
	
	if (!CbFbRec)
		return RETURN_NOT_FOUND;
		
  DEBUG ((EFI_D_ERROR, "Found coreboot video frame buffer information\n"));
  DEBUG ((EFI_D_ERROR, "physical_address: 0x%lx\n", CbFbRec->physical_address));
  DEBUG ((EFI_D_ERROR, "x_resolution: 0x%x\n", CbFbRec->x_resolution));
  DEBUG ((EFI_D_ERROR, "y_resolution: 0x%x\n", CbFbRec->y_resolution));
  DEBUG ((EFI_D_ERROR, "bits_per_pixel: 0x%x\n", CbFbRec->bits_per_pixel));
  DEBUG ((EFI_D_ERROR, "bytes_per_line: 0x%x\n", CbFbRec->bytes_per_line));
  
  DEBUG ((EFI_D_ERROR, "red_mask_size: 0x%x\n", CbFbRec->red_mask_size));
  DEBUG ((EFI_D_ERROR, "red_mask_pos: 0x%x\n", CbFbRec->red_mask_pos));
  DEBUG ((EFI_D_ERROR, "green_mask_size: 0x%x\n", CbFbRec->green_mask_size));
  DEBUG ((EFI_D_ERROR, "green_mask_pos: 0x%x\n", CbFbRec->green_mask_pos));
  DEBUG ((EFI_D_ERROR, "blue_mask_size: 0x%x\n", CbFbRec->blue_mask_size));
  DEBUG ((EFI_D_ERROR, "blue_mask_pos: 0x%x\n", CbFbRec->blue_mask_pos));
  DEBUG ((EFI_D_ERROR, "reserved_mask_size: 0x%x\n", CbFbRec->reserved_mask_size));
  DEBUG ((EFI_D_ERROR, "reserved_mask_pos: 0x%x\n", CbFbRec->reserved_mask_pos));
	
  pFbInfo->LinearFrameBuffer    = CbFbRec->physical_address;  
  pFbInfo->HorizontalResolution = CbFbRec->x_resolution;
  pFbInfo->VerticalResolution   = CbFbRec->y_resolution;
  pFbInfo->BitsPerPixel         = CbFbRec->bits_per_pixel;
  pFbInfo->BytesPerScanLine     = (UINT16)CbFbRec->bytes_per_line;
  pFbInfo->Red.Mask             = (1 << CbFbRec->red_mask_size) - 1;
  pFbInfo->Red.Position         = CbFbRec->red_mask_pos;
  pFbInfo->Green.Mask           = (1 << CbFbRec->green_mask_size) - 1;
  pFbInfo->Green.Position       = CbFbRec->green_mask_pos;
  pFbInfo->Blue.Mask            = (1 << CbFbRec->blue_mask_size) - 1;
  pFbInfo->Blue.Position        = CbFbRec->blue_mask_pos;
  pFbInfo->Reserved.Mask        = (1 << CbFbRec->reserved_mask_size) - 1;
  pFbInfo->Reserved.Position    = CbFbRec->reserved_mask_pos;  
  			
	return RETURN_SUCCESS;
}