sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

1, Use PrintLib in Duet loader

Browse Source 
2, Fix missing compress image in final disk image. I think the raw disk image had better be organized as our FD image format. I will discuss this after enabling DUET for R9.
3, Add more debug output in loader.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5128 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-04-25 09:30:24 +00:00
parent 8c1ba7f5e5
commit 3da85e633e
9 changed files with 604 additions and 546 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
DuetPkg/BootSector/Makefile
View File

@@ -126,7 +126,7 @@ $(BUILD_DIR)\FV\DxeIpl.z:$(BUILD_DIR)\IA32\DxeIpl.efi
$(BASETOOLS_DIR)\TianoCompress -e -o $(BUILD_DIR)\FV\DxeIpl.z $(BUILD_DIR)\IA32\DxeIpl.efi $(BASETOOLS_DIR)\TianoCompress -e -o $(BUILD_DIR)\FV\DxeIpl.z $(BUILD_DIR)\IA32\DxeIpl.efi
$(BUILD_DIR)\FV\Efildr32:$(BUILD_DIR)\IA32\EfiLoader.efi $(BUILD_DIR)\FV\DxeIpl.z $(BUILD_DIR)\FV\DUETEFIMAINFV.z $(BUILD_DIR)\FV\Efildr32:$(BUILD_DIR)\IA32\EfiLoader.efi $(BUILD_DIR)\FV\DxeIpl.z $(BUILD_DIR)\FV\DUETEFIMAINFV.z
$(BASETOOLS_DIR)\EfiLdrImage.exe -o $(BUILD_DIR)\FV\Efildr32 $(BUILD_DIR)\IA32\EfiLoader.efi $(BUILD_DIR)\FV\DxeIpl.z $(BUILD_DIR)\FV\DUETEFIMAINFV.z $(BASETOOLS_DIR)\EfiLdrImage.exe -o $(BUILD_DIR)\FV\Efildr32 $(BUILD_DIR)\IA32\EfiLoader.efi $(BUILD_DIR)\FV\DxeIpl.z $(BUILD_DIR)\FV\DxeMain.z $(BUILD_DIR)\FV\DUETEFIMAINFV.z
$(BUILD_DIR)\FV\Efildr:$(OUTPUT_DIR)\Start.com $(OUTPUT_DIR)\Efi32.com2 $(BUILD_DIR)\FV\Efildr32 $(BUILD_DIR)\FV\Efildr:$(OUTPUT_DIR)\Start.com $(OUTPUT_DIR)\Efi32.com2 $(BUILD_DIR)\FV\Efildr32
copy /b $(OUTPUT_DIR)\Start.com+$(OUTPUT_DIR)\Efi32.com2+$(BUILD_DIR)\FV\Efildr32 $(BUILD_DIR)\FV\Efildr copy /b $(OUTPUT_DIR)\Start.com+$(OUTPUT_DIR)\Efi32.com2+$(BUILD_DIR)\FV\Efildr32 $(BUILD_DIR)\FV\Efildr

1
DuetPkg/DuetPkg.dsc
View File

@@ -47,6 +47,7 @@
CacheMaintenanceLib|MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf CacheMaintenanceLib|MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf
PeCoffLib|MdePkg/Library/BasePeCoffLib/BasePeCoffLib.inf PeCoffLib|MdePkg/Library/BasePeCoffLib/BasePeCoffLib.inf
OemHookStatusCodeLib|IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.inf OemHookStatusCodeLib|IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.inf
PrintLib|MdePkg/Library/BasePrintLib/BasePrintLib.inf
[LibraryClasses.common.DXE_DRIVER] [LibraryClasses.common.DXE_DRIVER]
MemoryAllocationLib|MdePkg/Library/DxeMemoryAllocationLib/DxeMemoryAllocationLib.inf MemoryAllocationLib|MdePkg/Library/DxeMemoryAllocationLib/DxeMemoryAllocationLib.inf

23
DuetPkg/EfiLdr/EfiLdr.h
View File

@@ -30,6 +30,7 @@ Revision History:
#include <IndustryStandard/PeImage.h> #include <IndustryStandard/PeImage.h>
#include <Library/BaseLib.h> #include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h> #include <Library/BaseMemoryLib.h>
#include <Library/PrintLib.h>
#define INT15_E820_AddressRangeMemory 1 #define INT15_E820_AddressRangeMemory 1
#define INT15_E820_AddressRangeReserved 2 #define INT15_E820_AddressRangeReserved 2
@@ -80,28 +81,6 @@ typedef struct {
BIOS_MEMORY_MAP_ENTRY MemoryMapEntry[1]; BIOS_MEMORY_MAP_ENTRY MemoryMapEntry[1];
} BIOS_MEMORY_MAP; } BIOS_MEMORY_MAP;
EFI_STATUS
EFIAPI
UefiDecompressGetInfo (
IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
IN VOID *Source,
IN UINT32 SrcSize,
OUT UINT32 *DstSize,
OUT UINT32 *ScratchSize
);
EFI_STATUS
EFIAPI
TianoDecompress (
IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
IN VOID *Source,
IN UINT32 SrcSize,
IN OUT VOID *Destination,
IN UINT32 DstSize,
IN OUT VOID *Scratch,
IN UINT32 ScratchSize
);
EFILDR_LOADED_IMAGE DxeCoreImage; EFILDR_LOADED_IMAGE DxeCoreImage;
EFILDR_LOADED_IMAGE DxeIplImage; EFILDR_LOADED_IMAGE DxeIplImage;

1
DuetPkg/EfiLdr/EfiLdr.inf
View File

@@ -37,6 +37,7 @@
BaseLib BaseLib
BaseMemoryLib BaseMemoryLib
UefiApplicationEntryPoint UefiApplicationEntryPoint
PrintLib
[Sources.common] [Sources.common]
Debug.h Debug.h

89
DuetPkg/EfiLdr/EfiLoader.c
View File

@@ -22,6 +22,18 @@ Revision History:
#include "Support.h" #include "Support.h"
#include "Debug.h" #include "Debug.h"
#include "PeLoader.h" #include "PeLoader.h"
#include "TianoDecompress.h"
STATIC
VOID
SystemHang(
VOID
)
{
CHAR8 PrintBuffer[256];
AsciiSPrint (PrintBuffer, 256, "## FATEL ERROR ##: Fail to load DUET images! System hang!\n");
CpuDeadLoop();
}
VOID VOID
EfiLoader ( EfiLoader (
@@ -39,18 +51,18 @@ EfiLoader (
UINTN BfvPageNumber; UINTN BfvPageNumber;
UINTN BfvBase; UINTN BfvBase;
EFI_MAIN_ENTRYPOINT EfiMainEntrypoint; EFI_MAIN_ENTRYPOINT EfiMainEntrypoint;
CHAR8 PrintBuffer[256];
static EFILDRHANDOFF Handoff; static EFILDRHANDOFF Handoff;
PrintHeader ('A');
ClearScreen(); ClearScreen();
PrintString("EFI Loader\n");
PrintHeader ('A');
// PrintString("&BiosMemoryMapBaseAddress = "); AsciiSPrint (PrintBuffer, 256, "Enter DUET Loader ...\n", BiosMemoryMapBaseAddress);
// PrintValue64 ((UINT64)(&BiosMemoryMapBaseAddress)); PrintString (PrintBuffer);
// PrintString(" BiosMemoryMapBaseAddress = ");
// PrintValue(BiosMemoryMapBaseAddress); AsciiSPrint (PrintBuffer, 256, "BiosMemoryMapBaseAddress = 0x%x\n", BiosMemoryMapBaseAddress);
// PrintString("\n"); PrintString (PrintBuffer);
// //
// Add all EfiConventionalMemory descriptors to the table. If there are partial pages, then // Add all EfiConventionalMemory descriptors to the table. If there are partial pages, then
@@ -60,6 +72,9 @@ PrintHeader ('A');
NumberOfMemoryMapEntries = 0; NumberOfMemoryMapEntries = 0;
GenMemoryMap (&NumberOfMemoryMapEntries, EfiMemoryDescriptor, BiosMemoryMap); GenMemoryMap (&NumberOfMemoryMapEntries, EfiMemoryDescriptor, BiosMemoryMap);
AsciiSPrint (PrintBuffer, 256, "Get %d entries of memory map!\n", NumberOfMemoryMapEntries);
PrintString (PrintBuffer);
// //
// Get information on where the image is in memory // Get information on where the image is in memory
// //
@@ -67,7 +82,6 @@ PrintHeader ('A');
EFILDRHeader = (EFILDR_HEADER *)(UINTN)(EFILDR_HEADER_ADDRESS); EFILDRHeader = (EFILDR_HEADER *)(UINTN)(EFILDR_HEADER_ADDRESS);
EFILDRImage = (EFILDR_IMAGE *)(UINTN)(EFILDR_HEADER_ADDRESS + sizeof(EFILDR_HEADER)); EFILDRImage = (EFILDR_IMAGE *)(UINTN)(EFILDR_HEADER_ADDRESS + sizeof(EFILDR_HEADER));
PrintHeader ('D');
// //
// Point to the 4th image (Bfv) // Point to the 4th image (Bfv)
@@ -79,19 +93,25 @@ PrintHeader ('D');
// Decompress the image // Decompress the image
// //
Status = UefiDecompressGetInfo ( AsciiSPrint (PrintBuffer, 256, "Decompress BFV image, Image Address=0x%x! Offset=0x%x\n",
NULL, (UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Offset);
PrintString (PrintBuffer);
Status = TianoGetInfo (
(VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset), (VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Length, EFILDRImage->Length,
&DestinationSize, &DestinationSize,
&ScratchSize &ScratchSize
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); AsciiSPrint (PrintBuffer, 256, "Fail to get decompress information for BFV!\n");
PrintString (PrintBuffer);
SystemHang();
} }
Status = TianoDecompress ( Status = TianoDecompress (
NULL,
(VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset), (VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Length, EFILDRImage->Length,
(VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS, (VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS,
@@ -99,19 +119,22 @@ PrintHeader ('D');
(VOID *)(UINTN)((EFI_DECOMPRESSED_BUFFER_ADDRESS + DestinationSize + 0x1000) & 0xfffff000), (VOID *)(UINTN)((EFI_DECOMPRESSED_BUFFER_ADDRESS + DestinationSize + 0x1000) & 0xfffff000),
ScratchSize ScratchSize
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); AsciiSPrint (PrintBuffer, 256, "Fail to decompress BFV!\n");
PrintString (PrintBuffer);
SystemHang();
} }
BfvPageNumber = EFI_SIZE_TO_PAGES (DestinationSize); BfvPageNumber = EFI_SIZE_TO_PAGES (DestinationSize);
BfvBase = (UINTN) FindSpace (BfvPageNumber, &NumberOfMemoryMapEntries, EfiMemoryDescriptor, EfiRuntimeServicesData, EFI_MEMORY_WB); BfvBase = (UINTN) FindSpace (BfvPageNumber, &NumberOfMemoryMapEntries, EfiMemoryDescriptor, EfiRuntimeServicesData, EFI_MEMORY_WB);
if (BfvBase == 0) { if (BfvBase == 0) {
CpuDeadLoop(); SystemHang();
} }
ZeroMem ((VOID *)(UINTN)BfvBase, BfvPageNumber * EFI_PAGE_SIZE); ZeroMem ((VOID *)(UINTN)BfvBase, BfvPageNumber * EFI_PAGE_SIZE);
CopyMem ((VOID *)(UINTN)BfvBase, (VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS, DestinationSize); CopyMem ((VOID *)(UINTN)BfvBase, (VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS, DestinationSize);
PrintHeader ('B'); PrintHeader ('B');
// //
// Point to the 2nd image (DxeIpl) // Point to the 2nd image (DxeIpl)
@@ -122,20 +145,23 @@ PrintHeader ('B');
// //
// Decompress the image // Decompress the image
// //
AsciiSPrint (PrintBuffer, 256, "Decompress DxeIpl image, Image Address=0x%x! Offset=0x%x\n",
(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Offset);
Status = UefiDecompressGetInfo ( Status = TianoGetInfo (
NULL,
(VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset), (VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Length, EFILDRImage->Length,
&DestinationSize, &DestinationSize,
&ScratchSize &ScratchSize
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); AsciiSPrint (PrintBuffer, 256, "Fail to get decompress information for DxeIpl!\n");
PrintString (PrintBuffer);
SystemHang();
} }
Status = TianoDecompress ( Status = TianoDecompress (
NULL,
(VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset), (VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Length, EFILDRImage->Length,
(VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS, (VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS,
@@ -144,9 +170,14 @@ PrintHeader ('B');
ScratchSize ScratchSize
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); AsciiSPrint (PrintBuffer, 256, "Fail to decompress DxeIpl image\n");
PrintString (PrintBuffer);
SystemHang();
} }
AsciiSPrint (PrintBuffer, 256, "Start load DxeIpl PE image\n");
PrintString (PrintBuffer);
// //
// Load and relocate the EFI PE/COFF Firmware Image // Load and relocate the EFI PE/COFF Firmware Image
// //
@@ -157,7 +188,9 @@ PrintHeader ('B');
EfiMemoryDescriptor EfiMemoryDescriptor
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); AsciiSPrint (PrintBuffer, 256, "Fail to load and relocate DxeIpl PE image!\n");
PrintString (PrintBuffer);
SystemHang();
} }
// PrintString("Image.NoPages = "); // PrintString("Image.NoPages = ");
@@ -176,19 +209,17 @@ PrintHeader ('C');
// Decompress the image // Decompress the image
// //
Status = UefiDecompressGetInfo ( Status = TianoGetInfo (
NULL,
(VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset), (VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Length, EFILDRImage->Length,
&DestinationSize, &DestinationSize,
&ScratchSize &ScratchSize
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); SystemHang();
} }
Status = TianoDecompress ( Status = TianoDecompress (
NULL,
(VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset), (VOID *)(UINTN)(EFILDR_HEADER_ADDRESS + EFILDRImage->Offset),
EFILDRImage->Length, EFILDRImage->Length,
(VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS, (VOID *)(UINTN)EFI_DECOMPRESSED_BUFFER_ADDRESS,
@@ -197,7 +228,7 @@ PrintHeader ('C');
ScratchSize ScratchSize
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); SystemHang();
} }
// //
@@ -210,7 +241,7 @@ PrintHeader ('C');
EfiMemoryDescriptor EfiMemoryDescriptor
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
CpuDeadLoop(); SystemHang();
} }
PrintHeader ('E'); PrintHeader ('E');
@@ -261,6 +292,6 @@ PrintHeader ('F');
// There was a problem loading the image, so HALT the system. // There was a problem loading the image, so HALT the system.
// //
CpuDeadLoop(); SystemHang();
} }

32
DuetPkg/EfiLdr/PeLoader.c
View File

@@ -138,6 +138,7 @@ EfiLdrPeCoffLoadPeImage (
UINT32 NumberOfRvaAndSizes; UINT32 NumberOfRvaAndSizes;
EFI_IMAGE_DATA_DIRECTORY *DataDirectory; EFI_IMAGE_DATA_DIRECTORY *DataDirectory;
UINT64 ImageBase; UINT64 ImageBase;
CHAR8 PrintBuffer[256];
ZeroMem (&DosHdr, sizeof(DosHdr)); ZeroMem (&DosHdr, sizeof(DosHdr));
ZeroMem (&PeHdr, sizeof(PeHdr)); ZeroMem (&PeHdr, sizeof(PeHdr));
@@ -148,16 +149,18 @@ EfiLdrPeCoffLoadPeImage (
EfiLdrPeCoffImageRead (FHand, 0, sizeof(DosHdr), &DosHdr); EfiLdrPeCoffImageRead (FHand, 0, sizeof(DosHdr), &DosHdr);
if (DosHdr.e_magic != EFI_IMAGE_DOS_SIGNATURE) { if (DosHdr.e_magic != EFI_IMAGE_DOS_SIGNATURE) {
// DEBUG ((D_LOAD, "PeCoffLoadPeImage: Dos header signature not found\n")); AsciiSPrint (PrintBuffer, 256, "PeCoffLoadPeImage: Dos header signature not found\n");
PrintHeader ('F'); PrintString (PrintBuffer);
PrintHeader ('F');
return EFI_UNSUPPORTED; return EFI_UNSUPPORTED;
} }
EfiLdrPeCoffImageRead (FHand, DosHdr.e_lfanew, sizeof(PeHdr), &PeHdr); EfiLdrPeCoffImageRead (FHand, DosHdr.e_lfanew, sizeof(PeHdr), &PeHdr);
if (PeHdr.Pe32.Signature != EFI_IMAGE_NT_SIGNATURE) { if (PeHdr.Pe32.Signature != EFI_IMAGE_NT_SIGNATURE) {
// DEBUG ((D_LOAD, "PeCoffLoadPeImage: PE image header signature not found\n")); AsciiSPrint (PrintBuffer, 256, "PeCoffLoadPeImage: PE image header signature not found\n");
PrintHeader ('G'); PrintString (PrintBuffer);
PrintHeader ('G');
return EFI_UNSUPPORTED; return EFI_UNSUPPORTED;
} }
@@ -167,8 +170,9 @@ PrintHeader ('G');
Status = EfiLdrPeCoffSetImageType (Image, PeHdr.Pe32.OptionalHeader.Subsystem); Status = EfiLdrPeCoffSetImageType (Image, PeHdr.Pe32.OptionalHeader.Subsystem);
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
// DEBUG ((D_LOAD, "PeCoffLoadPeImage: Subsystem type not known\n")); AsciiSPrint (PrintBuffer, 256, "PeCoffLoadPeImage: Subsystem type not known\n");
PrintHeader ('H'); PrintString (PrintBuffer);
PrintHeader ('H');
return Status; return Status;
} }
@@ -178,8 +182,9 @@ PrintHeader ('H');
Status = EfiLdrPeCoffCheckImageMachineType (PeHdr.Pe32.FileHeader.Machine); Status = EfiLdrPeCoffCheckImageMachineType (PeHdr.Pe32.FileHeader.Machine);
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
// DEBUG ((D_LOAD, "PeCoffLoadPeImage: Incorrect machine type\n")); AsciiSPrint (PrintBuffer, 256, "PeCoffLoadPeImage: Incorrect machine type\n");
PrintHeader ('I'); PrintString (PrintBuffer);
PrintHeader ('I');
return Status; return Status;
} }
@@ -232,11 +237,12 @@ PrintHeader ('I');
} }
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
PrintHeader ('J'); PrintHeader ('J');
return Status; return Status;
} }
// DEBUG((D_LOAD, "LoadPe: new image base %lx\n", Image->ImageBasePage)); AsciiSPrint (PrintBuffer, 256, "LoadPe: new image base %lx\n", Image->ImageBasePage);
PrintString (PrintBuffer);
Image->Info.ImageBase = (VOID *)(UINTN)Image->ImageBasePage; Image->Info.ImageBase = (VOID *)(UINTN)Image->ImageBasePage;
Image->Info.ImageSize = (Image->NoPages << EFI_PAGE_SHIFT) - 1; Image->Info.ImageSize = (Image->NoPages << EFI_PAGE_SHIFT) - 1;
Image->ImageBase = (UINT8 *)(UINTN)Image->ImageBasePage; Image->ImageBase = (UINT8 *)(UINTN)Image->ImageBasePage;
@@ -254,7 +260,7 @@ PrintHeader ('J');
); );
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
PrintHeader ('K'); PrintHeader ('K');
return Status; return Status;
} }
@@ -319,7 +325,7 @@ PrintHeader ('K');
if (EFI_ERROR(Status) || !Base || !End) { if (EFI_ERROR(Status) || !Base || !End) {
// DEBUG((D_LOAD|D_ERROR, "LoadPe: Section %d was not loaded\n", Index)); // DEBUG((D_LOAD|D_ERROR, "LoadPe: Section %d was not loaded\n", Index));
PrintHeader ('L'); PrintHeader ('L');
return EFI_LOAD_ERROR; return EFI_LOAD_ERROR;
} }
@@ -381,7 +387,7 @@ PrintHeader ('M');
); );
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
PrintHeader ('N'); PrintHeader ('N');
return Status; return Status;
} }
} }

736
DuetPkg/EfiLdr/TianoDecompress.c
View File

@@ -1,10 +1,6 @@
/**@file /*++
UEFI and Custom Decompress Library
The function of UefiTianoDecompress() is interface for this module, Copyright (c) 2004 - 2006, Intel Corporation
it will do tiano or uefi decompress with different verison parameter.
See EFI specification 1.1 Chapter 17 to get LZ77 compress/decompress.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@@ -13,22 +9,91 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ Module Name:
#include <Guid/CustomDecompress.h> Decompress.c
#include "TianoDecompress.h"
/** Abstract:
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
Decompressor. Algorithm Ported from OPSD code (Decomp.asm)
@param Sd The global scratch data --*/
@param NumOfBits The number of bits to shift and read. #include <TianoDecompress.h>
**/ //
// Decompression algorithm begins here
//
#define BITBUFSIZ 32
#define MAXMATCH 256
#define THRESHOLD 3
#define CODE_BIT 16
#define UINT8_MAX 0xff
#define BAD_TABLE - 1
//
// C: Char&Len Set; P: Position Set; T: exTra Set
//
#define NC (0xff + MAXMATCH + 2 - THRESHOLD)
#define CBIT 9
#define MAXPBIT 5
#define TBIT 5
#define MAXNP ((1U << MAXPBIT) - 1)
#define NT (CODE_BIT + 3)
#if NT > MAXNP
#define NPT NT
#else
#define NPT MAXNP
#endif
typedef struct {
UINT8 *mSrcBase; // Starting address of compressed data
UINT8 *mDstBase; // Starting address of decompressed data
UINT32 mOutBuf;
UINT32 mInBuf;
UINT16 mBitCount;
UINT32 mBitBuf;
UINT32 mSubBitBuf;
UINT16 mBlockSize;
UINT32 mCompSize;
UINT32 mOrigSize;
UINT16 mBadTableFlag;
UINT16 mLeft[2 * NC - 1];
UINT16 mRight[2 * NC - 1];
UINT8 mCLen[NC];
UINT8 mPTLen[NPT];
UINT16 mCTable[4096];
UINT16 mPTTable[256];
//
// The length of the field 'Position Set Code Length Array Size' in Block Header.
// For EFI 1.1 de/compression algorithm, mPBit = 4
// For Tiano de/compression algorithm, mPBit = 5
//
UINT8 mPBit;
} SCRATCH_DATA;
STATIC
VOID VOID
FillBuf ( FillBuf (
IN SCRATCH_DATA *Sd, IN SCRATCH_DATA *Sd,
IN UINT16 NumOfBits IN UINT16 NumOfBits
) )
/*++
Routine Description:
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
Arguments:
Sd - The global scratch data
NumOfBits - The number of bits to shift and read.
Returns: (VOID)
--*/
{ {
Sd->mBitBuf = (UINT32) (Sd->mBitBuf << NumOfBits); Sd->mBitBuf = (UINT32) (Sd->mBitBuf << NumOfBits);
@@ -59,24 +124,30 @@ FillBuf (
Sd->mBitBuf |= Sd->mSubBitBuf >> Sd->mBitCount; Sd->mBitBuf |= Sd->mSubBitBuf >> Sd->mBitCount;
} }
/** STATIC
Get NumOfBits of bits out from mBitBuf
Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
NumOfBits of bits from source. Returns NumOfBits of bits that are
popped out.
@param Sd The global scratch data.
@param NumOfBits The number of bits to pop and read.
@return The bits that are popped out.
**/
UINT32 UINT32
GetBits ( GetBits (
IN SCRATCH_DATA *Sd, IN SCRATCH_DATA *Sd,
IN UINT16 NumOfBits IN UINT16 NumOfBits
) )
/*++
Routine Description:
Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
NumOfBits of bits from source. Returns NumOfBits of bits that are
popped out.
Arguments:
Sd - The global scratch data.
NumOfBits - The number of bits to pop and read.
Returns:
The bits that are popped out.
--*/
{ {
UINT32 OutBits; UINT32 OutBits;
@@ -87,22 +158,7 @@ GetBits (
return OutBits; return OutBits;
} }
/** STATIC
Creates Huffman Code mapping table according to code length array.
Creates Huffman Code mapping table for Extra Set, Char&Len Set
and Position Set according to code length array.
@param Sd The global scratch data
@param NumOfChar Number of symbols in the symbol set
@param BitLen Code length array
@param TableBits The width of the mapping table
@param Table The table
@retval 0 OK.
@retval BAD_TABLE The table is corrupted.
**/
UINT16 UINT16
MakeTable ( MakeTable (
IN SCRATCH_DATA *Sd, IN SCRATCH_DATA *Sd,
@@ -111,21 +167,39 @@ MakeTable (
IN UINT16 TableBits, IN UINT16 TableBits,
OUT UINT16 *Table OUT UINT16 *Table
) )
/*++
Routine Description:
Creates Huffman Code mapping table according to code length array.
Arguments:
Sd - The global scratch data
NumOfChar - Number of symbols in the symbol set
BitLen - Code length array
TableBits - The width of the mapping table
Table - The table
Returns:
0 - OK.
BAD_TABLE - The table is corrupted.
--*/
{ {
UINT16 Count[17]; UINT16 Count[17];
UINT16 Weight[17]; UINT16 Weight[17];
UINT16 Start[18]; UINT16 Start[18];
UINT16 *Pointer; UINT16 *Pointer;
UINT16 Index3; UINT16 Index3;
volatile UINT16 Index; UINT16 Index;
UINT16 Len; UINT16 Len;
UINT16 Char; UINT16 Char;
UINT16 JuBits; UINT16 JuBits;
UINT16 Avail; UINT16 Avail;
UINT16 NextCode; UINT16 NextCode;
UINT16 Mask; UINT16 Mask;
UINT16 WordOfStart;
UINT16 WordOfCount;
for (Index = 1; Index <= 16; Index++) { for (Index = 1; Index <= 16; Index++) {
Count[Index] = 0; Count[Index] = 0;
@@ -138,9 +212,7 @@ MakeTable (
Start[1] = 0; Start[1] = 0;
for (Index = 1; Index <= 16; Index++) { for (Index = 1; Index <= 16; Index++) {
WordOfStart = Start[Index]; Start[Index + 1] = (UINT16) (Start[Index] + (Count[Index] << (16 - Index)));
WordOfCount = Count[Index];
Start[Index + 1] = (UINT16) (WordOfStart + (WordOfCount << (16 - Index)));
} }
if (Start[17] != 0) { if (Start[17] != 0) {
@@ -156,8 +228,7 @@ MakeTable (
} }
while (Index <= 16) { while (Index <= 16) {
Weight[Index] = (UINT16) (1U << (16 - Index)); Weight[Index++] = (UINT16) (1U << (16 - Index));
Index++;
} }
Index = (UINT16) (Start[TableBits + 1] >> JuBits); Index = (UINT16) (Start[TableBits + 1] >> JuBits);
@@ -221,17 +292,26 @@ MakeTable (
return 0; return 0;
} }
/** STATIC
Decodes a position value.
@param Sd the global scratch data
@return The position value decoded.
**/
UINT32 UINT32
DecodeP ( DecodeP (
IN SCRATCH_DATA *Sd IN SCRATCH_DATA *Sd
) )
/*++
Routine Description:
Decodes a position value.
Arguments:
Sd - the global scratch data
Returns:
The position value decoded.
--*/
{ {
UINT16 Val; UINT16 Val;
UINT32 Mask; UINT32 Mask;
@@ -266,21 +346,7 @@ DecodeP (
return Pos; return Pos;
} }
/** STATIC
Reads code lengths for the Extra Set or the Position Set.
Read in the Extra Set or Pointion Set Length Arrary, then
generate the Huffman code mapping for them.
@param Sd The global scratch data.
@param nn Number of symbols.
@param nbit Number of bits needed to represent nn.
@param Special The special symbol that needs to be taken care of.
@retval 0 OK.
@retval BAD_TABLE Table is corrupted.
**/
UINT16 UINT16
ReadPTLen ( ReadPTLen (
IN SCRATCH_DATA *Sd, IN SCRATCH_DATA *Sd,
@@ -288,10 +354,29 @@ ReadPTLen (
IN UINT16 nbit, IN UINT16 nbit,
IN UINT16 Special IN UINT16 Special
) )
/*++
Routine Description:
Reads code lengths for the Extra Set or the Position Set
Arguments:
Sd - The global scratch data
nn - Number of symbols
nbit - Number of bits needed to represent nn
Special - The special symbol that needs to be taken care of
Returns:
0 - OK.
BAD_TABLE - Table is corrupted.
--*/
{ {
UINT16 Number; UINT16 Number;
UINT16 CharC; UINT16 CharC;
volatile UINT16 Index; UINT16 Index;
UINT32 Mask; UINT32 Mask;
Number = (UINT16) GetBits (Sd, nbit); Number = (UINT16) GetBits (Sd, nbit);
@@ -343,23 +428,28 @@ ReadPTLen (
return MakeTable (Sd, nn, Sd->mPTLen, 8, Sd->mPTTable); return MakeTable (Sd, nn, Sd->mPTLen, 8, Sd->mPTTable);
} }
/** STATIC
Reads code lengths for Char&Len Set.
Read in and decode the Char&Len Set Code Length Array, then
generate the Huffman Code mapping table for the Char&Len Set.
@param Sd the global scratch data
**/
VOID VOID
ReadCLen ( ReadCLen (
SCRATCH_DATA *Sd SCRATCH_DATA *Sd
) )
/*++
Routine Description:
Reads code lengths for Char&Len Set.
Arguments:
Sd - the global scratch data
Returns: (VOID)
--*/
{ {
UINT16 Number; UINT16 Number;
UINT16 CharC; UINT16 CharC;
volatile UINT16 Index; UINT16 Index;
UINT32 Mask; UINT32 Mask;
Number = (UINT16) GetBits (Sd, CBIT); Number = (UINT16) GetBits (Sd, CBIT);
@@ -432,22 +522,26 @@ ReadCLen (
return ; return ;
} }
/** STATIC
Decode a character/length value.
Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
Huffman code mapping table for Extra Set, Code&Len Set and
Position Set.
@param Sd The global scratch data.
@return The value decoded.
**/
UINT16 UINT16
DecodeC ( DecodeC (
SCRATCH_DATA *Sd SCRATCH_DATA *Sd
) )
/*++
Routine Description:
Decode a character/length value.
Arguments:
Sd - The global scratch data.
Returns:
The value decoded.
--*/
{ {
UINT16 Index2; UINT16 Index2;
UINT32 Mask; UINT32 Mask;
@@ -494,15 +588,24 @@ DecodeC (
return Index2; return Index2;
} }
/** STATIC
Decode the source data ad put the resulting data into the destination buffer.
@param Sd - The global scratch data
**/
VOID VOID
Decode ( Decode (
SCRATCH_DATA *Sd SCRATCH_DATA *Sd
) )
/*++
Routine Description:
Decode the source data and put the resulting data into the destination buffer.
Arguments:
Sd - The global scratch data
Returns: (VOID)
--*/
{ {
UINT16 BytesRemain; UINT16 BytesRemain;
UINT32 DataIdx; UINT32 DataIdx;
@@ -515,7 +618,7 @@ Decode (
for (;;) { for (;;) {
CharC = DecodeC (Sd); CharC = DecodeC (Sd);
if (Sd->mBadTableFlag != 0) { if (Sd->mBadTableFlag != 0) {
goto Done ; return ;
} }
if (CharC < 256) { if (CharC < 256) {
@@ -523,7 +626,7 @@ Decode (
// Process an Original character // Process an Original character
// //
if (Sd->mOutBuf >= Sd->mOrigSize) { if (Sd->mOutBuf >= Sd->mOrigSize) {
goto Done ; return ;
} else { } else {
Sd->mDstBase[Sd->mOutBuf++] = (UINT8) CharC; Sd->mDstBase[Sd->mOutBuf++] = (UINT8) CharC;
} }
@@ -542,7 +645,7 @@ Decode (
while ((INT16) (BytesRemain) >= 0) { while ((INT16) (BytesRemain) >= 0) {
Sd->mDstBase[Sd->mOutBuf++] = Sd->mDstBase[DataIdx++]; Sd->mDstBase[Sd->mOutBuf++] = Sd->mDstBase[DataIdx++];
if (Sd->mOutBuf >= Sd->mOrigSize) { if (Sd->mOutBuf >= Sd->mOrigSize) {
goto Done ; return ;
} }
BytesRemain--; BytesRemain--;
@@ -550,87 +653,106 @@ Decode (
} }
} }
Done:
return ; return ;
} }
/** EFI_STATUS
The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo(). GetInfo (
IN VOID *Source,
@param Source The source buffer containing the compressed data. IN UINT32 SrcSize,
@param SourceSize The size of source buffer OUT UINT32 *DstSize,
@param DestinationSize The size of destination buffer. OUT UINT32 *ScratchSize
@param ScratchSize The size of scratch buffer.
@retval RETURN_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
@retval RETURN_INVALID_PARAMETER - The source data is corrupted
**/
RETURN_STATUS
EFIAPI
UefiDecompressGetInfo (
IN CONST VOID *Source,
IN UINT32 SourceSize,
OUT UINT32 *DestinationSize,
OUT UINT32 *ScratchSize
) )
/*++
Routine Description:
The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().
Arguments:
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
DstSize - The size of destination buffer.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
{ {
UINT32 CompressedSize; UINT8 *Src;
ASSERT (Source != NULL);
ASSERT (DestinationSize != NULL);
ASSERT (ScratchSize != NULL);
if (SourceSize < 8) {
return RETURN_INVALID_PARAMETER;
}
CompressedSize = *(UINT32 *) Source;
if (SourceSize < (CompressedSize + 8)) {
return RETURN_INVALID_PARAMETER;
}
*ScratchSize = sizeof (SCRATCH_DATA); *ScratchSize = sizeof (SCRATCH_DATA);
*DestinationSize = *((UINT32 *) Source + 1);
return RETURN_SUCCESS; Src = Source;
if (SrcSize < 8) {
return EFI_INVALID_PARAMETER;
}
*DstSize = Src[4] + (Src[5] << 8) + (Src[6] << 16) + (Src[7] << 24);
return EFI_SUCCESS;
} }
/** EFI_STATUS
Decompress (
IN VOID *Source,
IN UINT32 SrcSize,
IN OUT VOID *Destination,
IN UINT32 DstSize,
IN OUT VOID *Scratch,
IN UINT32 ScratchSize,
IN UINT8 Version
)
/*++
Routine Description:
The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress(). The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().
@param Source The source buffer containing the compressed data. Arguments:
@param Destination The destination buffer to store the decompressed data
@param Scratch The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
@param Version 1 for UEFI Decompress algoruthm, 2 for Tiano Decompess algorithm
@retval RETURN_SUCCESS Decompression is successfull Source - The source buffer containing the compressed data.
@retval RETURN_INVALID_PARAMETER The source data is corrupted SrcSize - The size of source buffer
**/ Destination - The destination buffer to store the decompressed data
RETURN_STATUS DstSize - The size of destination buffer.
EFIAPI Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
UefiTianoDecompress ( ScratchSize - The size of scratch buffer.
IN CONST VOID *Source, Version - The version of de/compression algorithm.
IN OUT VOID *Destination, Version 1 for EFI 1.1 de/compression algorithm.
IN OUT VOID *Scratch, Version 2 for Tiano de/compression algorithm.
IN UINT32 Version
) Returns:
EFI_SUCCESS - Decompression is successfull
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
{ {
volatile UINT32 Index; UINT32 Index;
UINT32 CompSize; UINT32 CompSize;
UINT32 OrigSize; UINT32 OrigSize;
SCRATCH_DATA *Sd; EFI_STATUS Status;
CONST UINT8 *Src; SCRATCH_DATA *Sd;
UINT8 *Dst; UINT8 *Src;
UINT8 *Dst;
ASSERT (Source != NULL);
ASSERT (Destination != NULL);
ASSERT (Scratch != NULL);
Status = EFI_SUCCESS;
Src = Source; Src = Source;
Dst = Destination; Dst = Destination;
if (ScratchSize < sizeof (SCRATCH_DATA)) {
return EFI_INVALID_PARAMETER;
}
Sd = (SCRATCH_DATA *) Scratch; Sd = (SCRATCH_DATA *) Scratch;
if (SrcSize < 8) {
return EFI_INVALID_PARAMETER;
}
CompSize = Src[0] + (Src[1] << 8) + (Src[2] << 16) + (Src[3] << 24); CompSize = Src[0] + (Src[1] << 8) + (Src[2] << 16) + (Src[3] << 24);
OrigSize = Src[4] + (Src[5] << 8) + (Src[6] << 16) + (Src[7] << 24); OrigSize = Src[4] + (Src[5] << 8) + (Src[6] << 16) + (Src[7] << 24);
@@ -638,7 +760,15 @@ UefiTianoDecompress (
// If compressed file size is 0, return // If compressed file size is 0, return
// //
if (OrigSize == 0) { if (OrigSize == 0) {
return RETURN_SUCCESS; return Status;
}
if (SrcSize < CompSize + 8) {
return EFI_INVALID_PARAMETER;
}
if (DstSize != OrigSize) {
return EFI_INVALID_PARAMETER;
} }
Src = Src + 8; Src = Src + 8;
@@ -648,20 +778,26 @@ UefiTianoDecompress (
} }
// //
// The length of the field 'Position Set Code Length Array Size' in Block Header. // The length of the field 'Position Set Code Length Array Size' in Block Header.
// For UEFI 2.0 de/compression algorithm(Version 1), mPBit = 4 // For EFI 1.1 de/compression algorithm(Version 1), mPBit = 4
// For Tiano de/compression algorithm(Version 2), mPBit = 5 // For Tiano de/compression algorithm(Version 2), mPBit = 5
// //
switch (Version) { switch (Version) {
case 1 : case 1:
Sd->mPBit = 4; Sd->mPBit = 4;
break; break;
case 2 :
Sd->mPBit = 5; case 2:
break; Sd->mPBit = 5;
default: break;
ASSERT (FALSE);
default:
//
// Currently, only have 2 versions
//
return EFI_INVALID_PARAMETER;
} }
Sd->mSrcBase = (UINT8 *)Src;
Sd->mSrcBase = Src;
Sd->mDstBase = Dst; Sd->mDstBase = Dst;
Sd->mCompSize = CompSize; Sd->mCompSize = CompSize;
Sd->mOrigSize = OrigSize; Sd->mOrigSize = OrigSize;
@@ -680,133 +816,177 @@ UefiTianoDecompress (
// //
// Something wrong with the source // Something wrong with the source
// //
return RETURN_INVALID_PARAMETER; Status = EFI_INVALID_PARAMETER;
} }
return RETURN_SUCCESS; return Status;
} }
/** EFI_STATUS
The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().
@param Source - The source buffer containing the compressed data.
@param Destination - The destination buffer to store the decompressed data
@param Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
@retval RETURN_SUCCESS - Decompression is successfull
@retval RETURN_INVALID_PARAMETER - The source data is corrupted
**/
RETURN_STATUS
EFIAPI EFIAPI
UefiDecompress ( EfiGetInfo (
IN CONST VOID *Source, IN VOID *Source,
IN OUT VOID *Destination, IN UINT32 SrcSize,
IN OUT VOID *Scratch OUT UINT32 *DstSize,
OUT UINT32 *ScratchSize
) )
/*++
Routine Description:
The implementation is same as that of EFI_DECOMPRESS_PROTOCOL.GetInfo().
Arguments:
This - The protocol instance pointer
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
DstSize - The size of destination buffer.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
{ {
return UefiTianoDecompress (Source, Destination, Scratch, 1); return GetInfo (
Source,
SrcSize,
DstSize,
ScratchSize
);
} }
/** EFI_STATUS
The internal implementation of Tiano decompress GetInfo.
@param InputSection Buffer containing the input GUIDed section to be processed.
@param OutputBufferSize The size of OutputBuffer.
@param ScratchBufferSize The size of ScratchBuffer.
@param SectionAttribute The attribute of the input guided section.
@retval RETURN_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
@retval RETURN_INVALID_PARAMETER - The source data is corrupted
The GUID in InputSection does not match this instance guid.
**/
RETURN_STATUS
EFIAPI EFIAPI
TianoDecompressGetInfo ( EfiDecompress (
IN CONST VOID *InputSection, IN VOID *Source,
OUT UINT32 *OutputBufferSize, IN UINT32 SrcSize,
OUT UINT32 *ScratchBufferSize, IN OUT VOID *Destination,
OUT UINT16 *SectionAttribute IN UINT32 DstSize,
IN OUT VOID *Scratch,
IN UINT32 ScratchSize
) )
/*++
Routine Description:
The implementation is same as that of EFI_DECOMPRESS_PROTOCOL.Decompress().
Arguments:
This - The protocol instance pointer
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
Destination - The destination buffer to store the decompressed data
DstSize - The size of destination buffer.
Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - Decompression is successfull
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
{ {
ASSERT (SectionAttribute != NULL);
if (InputSection == NULL) {
return RETURN_INVALID_PARAMETER;
}
if (!CompareGuid (
&gTianoCustomDecompressGuid,
&(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
return RETURN_INVALID_PARAMETER;
}
// //
// Get guid attribute of guid section. // For EFI 1.1 de/compression algorithm, the version is 1.
// //
*SectionAttribute = ((EFI_GUID_DEFINED_SECTION *) InputSection)->Attributes; return Decompress (
Source,
// SrcSize,
// Call Tiano GetInfo to get the required size info. Destination,
// DstSize,
return UefiDecompressGetInfo ( Scratch,
(UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset, ScratchSize,
(*(UINT32 *) (((EFI_COMMON_SECTION_HEADER *) InputSection)->Size) & 0x00ffffff) - ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset, 1
OutputBufferSize, );
ScratchBufferSize
);
} }
/** EFI_STATUS
The implementation of Tiano Decompress(). EFIAPI
TianoGetInfo (
IN VOID *Source,
IN UINT32 SrcSize,
OUT UINT32 *DstSize,
OUT UINT32 *ScratchSize
)
/*++
@param InputSection Buffer containing the input GUIDed section to be processed. Routine Description:
@param OutputBuffer OutputBuffer to point to the start of the section's contents.
if guided data is not prcessed. Otherwise,
OutputBuffer to contain the output data, which is allocated by the caller.
@param ScratchBuffer A pointer to a caller-allocated buffer for function internal use.
@param AuthenticationStatus A pointer to a caller-allocated UINT32 that indicates the
authentication status of the output buffer.
@retval RETURN_SUCCESS Decompression is successfull The implementation is same as that of EFI_TIANO_DECOMPRESS_PROTOCOL.GetInfo().
@retval RETURN_INVALID_PARAMETER The source data is corrupted, or
The GUID in InputSection does not match this instance guid.
**/ Arguments:
RETURN_STATUS
This - The protocol instance pointer
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
DstSize - The size of destination buffer.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
{
return GetInfo (
Source,
SrcSize,
DstSize,
ScratchSize
);
}
EFI_STATUS
EFIAPI EFIAPI
TianoDecompress ( TianoDecompress (
IN CONST VOID *InputSection, IN VOID *Source,
OUT VOID **OutputBuffer, IN UINT32 SrcSize,
IN VOID *ScratchBuffer, OPTIONAL IN OUT VOID *Destination,
OUT UINT32 *AuthenticationStatus IN UINT32 DstSize,
IN OUT VOID *Scratch,
IN UINT32 ScratchSize
) )
/*++
Routine Description:
The implementation is same as that of EFI_TIANO_DECOMPRESS_PROTOCOL.Decompress().
Arguments:
This - The protocol instance pointer
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
Destination - The destination buffer to store the decompressed data
DstSize - The size of destination buffer.
Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - Decompression is successfull
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
{ {
ASSERT (OutputBuffer != NULL);
if (InputSection == NULL) {
return RETURN_INVALID_PARAMETER;
}
if (!CompareGuid (
&gTianoCustomDecompressGuid,
&(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
return RETURN_INVALID_PARAMETER;
}
// //
// Set Authentication to Zero. // For Tiano de/compression algorithm, the version is 2.
// //
*AuthenticationStatus = 0; return Decompress (
Source,
// SrcSize,
// Call Tiano Decompress to get the raw data Destination,
// DstSize,
return UefiTianoDecompress ( Scratch,
(UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset, ScratchSize,
*OutputBuffer,
ScratchBuffer,
2 2
); );
} }

264
DuetPkg/EfiLdr/TianoDecompress.h
View File

@@ -23,208 +23,68 @@
#include <Library/DebugLib.h> #include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h> #include <Library/BaseMemoryLib.h>
// EFI_STATUS
// Decompression algorithm begins here
//
#define BITBUFSIZ 32
#define MAXMATCH 256
#define THRESHOLD 3
#define CODE_BIT 16
#define BAD_TABLE - 1
//
// C: Char&Len Set; P: Position Set; T: exTra Set
//
#define NC (0xff + MAXMATCH + 2 - THRESHOLD)
#define CBIT 9
#define MAXPBIT 5
#define TBIT 5
#define MAXNP ((1U << MAXPBIT) - 1)
#define NT (CODE_BIT + 3)
#if NT > MAXNP
#define NPT NT
#else
#define NPT MAXNP
#endif
typedef struct {
UINT8 *mSrcBase; // Starting address of compressed data
UINT8 *mDstBase; // Starting address of decompressed data
UINT32 mOutBuf;
UINT32 mInBuf;
UINT16 mBitCount;
UINT32 mBitBuf;
UINT32 mSubBitBuf;
UINT16 mBlockSize;
UINT32 mCompSize;
UINT32 mOrigSize;
UINT16 mBadTableFlag;
UINT16 mLeft[2 * NC - 1];
UINT16 mRight[2 * NC - 1];
UINT8 mCLen[NC];
UINT8 mPTLen[NPT];
UINT16 mCTable[4096];
UINT16 mPTTable[256];
//
// The length of the field 'Position Set Code Length Array Size' in Block Header.
// For UEFI 2.0 de/compression algorithm, mPBit = 4
// For Tiano de/compression algorithm, mPBit = 5
//
UINT8 mPBit;
} SCRATCH_DATA;
/**
Read NumOfBit of bits from source into mBitBuf
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
@param Sd The global scratch data
@param NumOfBits The number of bits to shift and read.
**/
VOID
FillBuf (
IN SCRATCH_DATA *Sd,
IN UINT16 NumOfBits
);
/**
Get NumOfBits of bits out from mBitBuf
Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
NumOfBits of bits from source. Returns NumOfBits of bits that are
popped out.
@param Sd The global scratch data.
@param NumOfBits The number of bits to pop and read.
@return The bits that are popped out.
**/
UINT32
GetBits (
IN SCRATCH_DATA *Sd,
IN UINT16 NumOfBits
);
/**
Creates Huffman Code mapping table according to code length array.
Creates Huffman Code mapping table for Extra Set, Char&Len Set
and Position Set according to code length array.
@param Sd The global scratch data
@param NumOfChar Number of symbols in the symbol set
@param BitLen Code length array
@param TableBits The width of the mapping table
@param Table The table
@retval 0 OK.
@retval BAD_TABLE The table is corrupted.
**/
UINT16
MakeTable (
IN SCRATCH_DATA *Sd,
IN UINT16 NumOfChar,
IN UINT8 *BitLen,
IN UINT16 TableBits,
OUT UINT16 *Table
);
/**
Decodes a position value.
Get a position value according to Position Huffman Table.
@param Sd the global scratch data
@return The position value decoded.
**/
UINT32
DecodeP (
IN SCRATCH_DATA *Sd
);
/**
Reads code lengths for the Extra Set or the Position Set.
Read in the Extra Set or Pointion Set Length Arrary, then
generate the Huffman code mapping for them.
@param Sd The global scratch data.
@param nn Number of symbols.
@param nbit Number of bits needed to represent nn.
@param Special The special symbol that needs to be taken care of.
@retval 0 OK.
@retval BAD_TABLE Table is corrupted.
**/
UINT16
ReadPTLen (
IN SCRATCH_DATA *Sd,
IN UINT16 nn,
IN UINT16 nbit,
IN UINT16 Special
);
/**
Reads code lengths for Char&Len Set.
Read in and decode the Char&Len Set Code Length Array, then
generate the Huffman Code mapping table for the Char&Len Set.
@param Sd the global scratch data
**/
VOID
ReadCLen (
SCRATCH_DATA *Sd
);
/**
Decode a character/length value.
Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
Huffman code mapping table for Extra Set, Code&Len Set and
Position Set.
@param Sd The global scratch data.
@return The value decoded.
**/
UINT16
DecodeC (
SCRATCH_DATA *Sd
);
/**
Decode the source data and put the resulting data into the destination buffer.
Decode the source data and put the resulting data into the destination buffer.
@param Sd The global scratch data
**/
VOID
Decode (
SCRATCH_DATA *Sd
);
RETURN_STATUS
EFIAPI EFIAPI
UefiTianoDecompress ( TianoGetInfo (
IN CONST VOID *Source, IN VOID *Source,
IN OUT VOID *Destination, IN UINT32 SrcSize,
IN OUT VOID *Scratch, OUT UINT32 *DstSize,
IN UINT32 Version OUT UINT32 *ScratchSize
); )
/*++
Routine Description:
The implementation is same as that of EFI_TIANO_DECOMPRESS_PROTOCOL.GetInfo().
Arguments:
This - The protocol instance pointer
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
DstSize - The size of destination buffer.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
;
EFI_STATUS
EFIAPI
TianoDecompress (
IN VOID *Source,
IN UINT32 SrcSize,
IN OUT VOID *Destination,
IN UINT32 DstSize,
IN OUT VOID *Scratch,
IN UINT32 ScratchSize
)
/*++
Routine Description:
The implementation is same as that of EFI_TIANO_DECOMPRESS_PROTOCOL.Decompress().
Arguments:
This - The protocol instance pointer
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
Destination - The destination buffer to store the decompressed data
DstSize - The size of destination buffer.
Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - Decompression is successfull
EFI_INVALID_PARAMETER - The source data is corrupted
--*/
;
#endif #endif

2
DuetPkg/PostBuild.bat
View File

@@ -11,5 +11,5 @@ set OUTPUT_DIR=%BUILD_DIR%\IA32\DuetPkg\BootSector\BootSector\OUTPUT
%BASETOOLS_DIR%\TianoCompress -e -o %BUILD_DIR%\FV\DUETEFIMAINFV.z %BUILD_DIR%\FV\DUETEFIMAINFV.Fv %BASETOOLS_DIR%\TianoCompress -e -o %BUILD_DIR%\FV\DUETEFIMAINFV.z %BUILD_DIR%\FV\DUETEFIMAINFV.Fv
%BASETOOLS_DIR%\TianoCompress -e -o %BUILD_DIR%\FV\DxeMain.z %BUILD_DIR%\IA32\DxeMain.efi %BASETOOLS_DIR%\TianoCompress -e -o %BUILD_DIR%\FV\DxeMain.z %BUILD_DIR%\IA32\DxeMain.efi
%BASETOOLS_DIR%\TianoCompress -e -o %BUILD_DIR%\FV\DxeIpl.z %BUILD_DIR%\IA32\DxeIpl.efi %BASETOOLS_DIR%\TianoCompress -e -o %BUILD_DIR%\FV\DxeIpl.z %BUILD_DIR%\IA32\DxeIpl.efi
%BASETOOLS_DIR%\EfiLdrImage.exe -o %BUILD_DIR%\FV\Efildr32 %BUILD_DIR%\IA32\EfiLoader.efi %BUILD_DIR%\FV\DxeIpl.z %BUILD_DIR%\FV\DUETEFIMAINFV.z %BASETOOLS_DIR%\EfiLdrImage.exe -o %BUILD_DIR%\FV\Efildr32 %BUILD_DIR%\IA32\EfiLoader.efi %BUILD_DIR%\FV\DxeIpl.z %BUILD_DIR%\FV\DxeMain.z %BUILD_DIR%\FV\DUETEFIMAINFV.z
copy /b %OUTPUT_DIR%\Start.com+%OUTPUT_DIR%\Efi32.com2+%BUILD_DIR%\FV\Efildr32 %BUILD_DIR%\FV\Efildr copy /b %OUTPUT_DIR%\Start.com+%OUTPUT_DIR%\Efi32.com2+%BUILD_DIR%\FV\Efildr32 %BUILD_DIR%\FV\Efildr