33. EfiRom 유틸리티를 사용한 PCI Option ROM 이미지 파싱 및 생성

이번 장에서는 BaseTools 유틸리티 EfiRom을 사용해 OptionROM 이미지를 분석한다. EDKII 폴더에서 . edksetup.sh를 실행하면 EfiRom을 사용할 수 있다.

$ EfiRom -h
Usage: EfiRom -f VendorId -i DeviceId [options] [file name<s>]

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.

Options:
  -o FileName, --output FileName
            File will be created to store the output content.
  -e EfiFileName
            EFI PE32 image files.
  -ec EfiFileName
            EFI PE32 image files and will be compressed.
  -b BinFileName
            Legacy binary files.
  -l ClassCode
            Hex ClassCode in the PCI data structure header.
  -r Rev    Hex Revision in the PCI data structure header.
  -n        Not to automatically set the LAST bit in the last file.
  -f VendorId
            Hex PCI Vendor ID for the device OpROM, must be specified
  -i DeviceId
            One or more hex PCI Device IDs for the device OpROM, must be specified
  -p, --pci23
            Default layout meets PCI 3.0 specifications
            specifying this flag will for a PCI 2.3 layout.
  -d, --dump
            Dump the headers of an existing option ROM image.
  -v, --verbose
            Turn on verbose output with informational messages.
  --version Show program's version number and exit.
  -h, --help
            Show this help message and exit.
  -q, --quiet
            Disable all messages except FATAL ERRORS.
  --debug [#,0-9]
            Enable debug messages at level #.

EfiRom 설명서의 전체 버전은 아래 링크에서 확인할 수 있다. https://github.com/tianocore/edk2/blob/master/BaseTools/UserManuals/EfiRom_Utility_Man_Page.rtf

EfiRom에 대한 소스 코드는 아래에서 확인할 수 있다. https://github.com/tianocore/edk2/tree/master/BaseTools/Source/C/EfiRom

EfiRom을 사용해 아래 작업을 할 수 있다.

  • dump Option ROM images

  • create Option ROM images from EFI drivers and/or Legacy binary images

tianocore 문서를 보고 싶다면 아래 링크를 통해 확인할 수 있다.

ipxe rom

Preboot eXecution Environment(PXE)는 네트워크를 통해 수신된 이미지로 부팅하기 위한 표준이다. https://en.wikipedia.org/wiki/Preboot_Execution_Environment

PXE 부팅에 특정 PCI 네트워크 카드를 사용하는 방법을 알기 위해서는 BIOS에서 일부 네트워크 카드를 알아야 한다. 그러나 BIOS는 OS가 아니므로 모든 PCI 네트워크 카드용 드라이버를 포함할 수 없다. 따라서 이 문제는 OptionROM 펌웨어를 통해 해결한다. PCI 네트워크 카드에는 PXE 부팅에 필요한 모든 코드가 포함되어 있다. 그러나 모든 카드에 그런 펌웨어가 있는 것은 아니기 때문에 iPXE 프로젝트를 활용할 수 있다.

iPXE는 오픈 소스 네트워크 부팅 펌웨어(https://ipxe.org/)이다. 일부 추가 기능으로 향상된 전체 PXE 기능을 제공하고 다양한 PCI 네트워크 카드를 지원한다. https://ipxe.org/appnote/hardware_drivers

iPXE는 EFI 응용 프로그램 또는 EFI/Legacy Option ROM으로 컴파일 할 수 있다. 빌드 대상에 대한 자세한 내용은 아래 링크에서 확인할 수 있다. https://ipxe.org/appnote/buildtargets

iPXE를 다운받는다.

git clone git://git.ipxe.org/ipxe.git
cd ipxe/src

이제 이미지를 빌드한다.

$ sudo apt-get install liblzma-dev
$ make bin-x86_64-efi/ipxe.efi 			# EFI app with all devices
$ make bin-x86_64-efi/8086100e.efirom		# EFI ROM vendev: 8086:100e
$ make bin/8086100e.rom                         # Legacy ROM vendev: 8086:100e

UEFI Shell에서 직접 ipxe.efi를 실행할 수 있다. 이것은 앞에서 계속 만든 것과 유사한 간단한 UEFI 애플리케이션이다.

소스 코드를 확인하고 싶으면 아래 링크를 통해 확인한다. https://github.com/ipxe/ipxe/blob/master/src/image/efi_image.c

8086100e.rom은 8086:100e 네트워크 카드용 Legacy 코드 이미지 PCI Option ROM이다.

8086100e.efirom은 8086:100e 네트워크 카드용 UEFI 코드 이미지 PCI Option ROM이다.

HexDump로 OptionROM 이미지를 확인하면 표준 AA55PCIR 시그니처가 표시된다.

$ hexdump bin/8086100e.rom -C -n 64
00000000  55 aa 86 e9 a2 00 30 00  00 00 00 00 00 00 00 00  |U.....0.........|
00000010  9c 00 00 00 00 00 84 00  1c 00 40 00 50 43 49 52  |..........@.PCIR|
00000020  86 80 0e 10 bf 04 1c 00  03 00 00 02 86 00 01 00  |................|
00000030  00 80 07 00 00 00 00 00  8d b4 00 00 8d b4 00 00  |................|
00000040
$ hexdump bin-x86_64-efi/8086100e.efirom -C -n 64
00000000  55 aa d0 00 f1 0e 00 00  0b 00 64 86 01 00 00 00  |U.........d.....|
00000010  00 00 00 00 00 00 38 00  1c 00 00 00 50 43 49 52  |......8.....PCIR|
00000020  86 80 0e 10 00 00 18 00  00 00 00 02 d0 00 00 00  |................|
00000030  03 80 00 00 87 00 00 00  0d 9e 01 00 00 d2 02 00  |................|
00000040

bin/8086100e.rom파일을 EfiRom을 통해서도 확인할 수 있다.

$ EfiRom -d bin/8086100e.rom
Image 1 -- Offset 0x0
  ROM header contents
    Signature              0xAA55
    PCIR offset            0x001C
    Signature               PCIR
    Vendor ID               0x8086
    Device ID               0x100E
    Length                  0x001C
    Revision                0x0003
    DeviceListOffset        0x4BF
    Device list contents
      0x100E
    Class Code              0x020000
    Image size              0x10C00
    Code revision:          0x0001
    MaxRuntimeImageLength   0x07
    ConfigUtilityCodeHeaderOffset 0x00
    DMTFCLPEntryPointOffset 0x00
    Indicator               0x80   (last image)
    Code type               0x00

반면 EfiRom을 통해bin-x86_64-efi/8086100e.efirom를 확인하면 에러가 발생한다.

$ EfiRom -d bin-x86_64-efi/8086100e.efirom
EfiRom: ERROR 1002: No PciRom input file
  No *.rom input file

에러가 발생한 이유는 메시지에서도 확인할 수 있듯이 EfiRom은 확장자가 .rom인 파일에만 사용할 수 있기 때문에 확장자를 변경하고 다시 사용한다.

$ cp bin-x86_64-efi/8086100e.efirom bin-x86_64-efi/8086100e.rom
$ EfiRom -d bin-x86_64-efi/8086100e.rom
Image 1 -- Offset 0x0
  ROM header contents
    Signature              0xAA55
    PCIR offset            0x001C
    Signature               PCIR
    Vendor ID               0x8086
    Device ID               0x100E
    Length                  0x0018
    Revision                0x0000
    DeviceListOffset        0x00
    Class Code              0x020000
    Image size              0x1A000
    Code revision:          0x0000
    MaxRuntimeImageLength   0x00
    ConfigUtilityCodeHeaderOffset 0x87
    DMTFCLPEntryPointOffset 0x00
    Indicator               0x80   (last image)
    Code type               0x03   (EFI image)
  EFI ROM header contents
    EFI Signature          0x0EF1
    Compression Type       0x0001 (compressed)
    Machine type           0x8664 (X64)
    Subsystem              0x000B (EFI boot service driver)
    EFI image offset       0x0038 (@0x38)

EfiRom은 현재 EFI ROM 이미지에서 Option ROM을 결합 할 수 없다. 그러나 resulting Option ROM에서 EFI PE32 이미지 파일을 EFI ROM 이미지의 소스로 사용할 수 있다. 그래서 다른 대상을 컴파일해야 한다.

$ make bin-x86_64-efi/8086100e.efidrv

이제 Legacy와 EFI ROM이 함께 결합된 OptionROM 이미지를 만들 수 있다.

$ EfiRom -f 0x8086 -i 0x100e -b bin/8086100e.rom -ec bin-x86_64-efi/8086100e.efidrv -o bin/8086100e_optionrom.rom
$ EfiRom -d bin/8086100e_optionrom.rom
Image 1 -- Offset 0x0
  ROM header contents
    Signature              0xAA55
    PCIR offset            0x001C
    Signature               PCIR
    Vendor ID               0x8086
    Device ID               0x100E
    Length                  0x001C
    Revision                0x0003
    DeviceListOffset        0x4BF
    Device list contents
      0x100E
    Class Code              0x020000
    Image size              0x10C00
    Code revision:          0x0001
    MaxRuntimeImageLength   0x07
    ConfigUtilityCodeHeaderOffset 0x00
    DMTFCLPEntryPointOffset 0x00
    Indicator               0x00
    Code type               0x00
Image 2 -- Offset 0x10C00
  ROM header contents
    Signature              0xAA55
    PCIR offset            0x001C
    Signature               PCIR
    Vendor ID               0x8086
    Device ID               0x100E
    Length                  0x001C
    Revision                0x0003
    DeviceListOffset        0x00
    Class Code              0x000000
    Image size              0x1A000
    Code revision:          0x0000
    MaxRuntimeImageLength   0x00
    ConfigUtilityCodeHeaderOffset 0x00
    DMTFCLPEntryPointOffset 0x00
    Indicator               0x80   (last image)
    Code type               0x03   (EFI image)
  EFI ROM header contents
    EFI Signature          0x0EF1
    Compression Type       0x0001 (compressed)
    Machine type           0x8664 (X64)
    Subsystem              0x000B (EFI boot service driver)
    EFI image offset       0x0038 (@0x10C38)

VGA rom

SeqBIOS는 일반적인 x86 독점 BIOS가 구현하는 표준 BIOS 호출 인터페이스를 구현하는 오픈 소스 Legacy BIOS 구현이다. https://github.com/coreboot/seabios SeaVGABIOS는 SeaBIOS 프로젝트의 하위 프로젝트로 16비트 x86 VGA BIOS의 오픈 소스 구현이다. https://github.com/coreboot/seabios/blob/master/docs/SeaVGABIOS.md 즉, PCI 그래픽 장치를 위한 Legacy Option ROM를 빌드한다.

SeaBIOS는 빌드 구성에 Kconfig 시스템을 사용한다. VGA BIOS의 주요 옵션은 아래 링크를 통해 확인할 수 있다. https://github.com/coreboot/seabios/blob/master/vgasrc/Kconfig 이 파일에서 옵션 중 하나는 Vendor/Device 쌍이 1234:1111인 OptionROM인 것을 알 수 있다. QEMU에서 봤던 것과 일치한다.

    config VGA_VID
        depends on VGA_PCI
        hex
        prompt "PCI Vendor ID" if OVERRIDE_PCI_ID
        default 0x1013 if VGA_CIRRUS
        default 0x1002 if VGA_ATI
        default 0x1234 if VGA_BOCHS_STDVGA
        default 0x15ad if VGA_BOCHS_VMWARE
        default 0x1b36 if VGA_BOCHS_QXL
        default 0x1af4 if VGA_BOCHS_VIRTIO
        default 0x100b if VGA_GEODEGX2
        default 0x1022 if VGA_GEODELX
        default 0x1234 if DISPLAY_BOCHS                 <--------------
        default 0x0000
        help
            Vendor ID for the PCI ROM

    config VGA_DID
        depends on VGA_PCI
        hex
        prompt "PCI Vendor ID" if OVERRIDE_PCI_ID
        default 0x00b8 if VGA_CIRRUS
        default 0x5159 if VGA_ATI
        default 0x1111 if VGA_BOCHS_STDVGA
        default 0x0405 if VGA_BOCHS_VMWARE
        default 0x0100 if VGA_BOCHS_QXL
        default 0x1050 if VGA_BOCHS_VIRTIO
        default 0x0030 if VGA_GEODEGX2
        default 0x2081 if VGA_GEODELX
        default 0x1111 if DISPLAY_BOCHS                 <---------------
        default 0x0000
        help
            Device ID for the PCI ROM

DISPLAY_BOCHS에 대해서 궁금하다면, 아래는 옵션에 대한 도움말이다.

        config DISPLAY_BOCHS
            depends on QEMU
            bool "qemu bochs-display support"
            select VGA_EMULATE_TEXT
            help
                Build support for the qemu bochs-display device, which
                is basically qemu stdvga without the legacy vga
                emulation, supporting only 16+32 bpp VESA video modes
                in a linear framebuffer.  So this uses cbvga text mode
                emulation.

                The bochs-display device is available in qemu
                v3.0+. The vgabios works with the qemu stdvga too (use
                "qemu -device VGA,romfile=/path/to/vgabios.bin")".

이제 SeaBIOS VGA 이미지를 빌드한다. 아래 명령어를 통해 필요한 패키지를 설치하고, SeaBIOS 소스 다운로드 및 빌드를 진행한다.

$ sudo apt-get install python libncurses-dev
$ git clone https://github.com/coreboot/seabios.git
$ cd seabios
$ make menuconfig

SeaBIOS를 빌드하기 전에 VGA ROM에 대한 설정을 변경해야 하기 때문에 아래와 menuconfig 화면에서 아래 경로를 따라 qemu bochs-display support를 선택한다.

VGA ROM ---> VGA Hardware Type 
qemu bochs-display support 선택

설정을 저장하고 빌드를 진행한다.

$ make

빌드 후 VGA Option ROM은 out/vgabios.bin으로 존재한다. EfiRom은 ROM 파일의 확장자가 *.rom일 경우에만 사용할 수 있으므로 vgabios.bin 파일을 vgabios.rom 으로 복사본을 생성한다. EfiRom을 사용해 vgabios.rom 파일을 덤프해보면 아래와 같이 확인할 수 있다.

$ cp out/vgabios.bin out/vgabios.rom
$ EfiRom -d out/vgabios.rom
Image 1 -- Offset 0x0
  ROM header contents
    Signature              0xAA55
    PCIR offset            0x6E00
    Signature               PCIR
    Vendor ID               0x1234
    Device ID               0x1111
    Length                  0x0018
    Revision                0x0000
    DeviceListOffset        0x00
    Class Code              0x030000
    Image size              0x7000
    Code revision:          0x0001
    MaxRuntimeImageLength   0x00
    ConfigUtilityCodeHeaderOffset 0x9066
    DMTFCLPEntryPointOffset 0x9066
    Indicator               0x80   (last image)
    Code type               0x00

결과는 QEMU 시스템에서 유틸리티를 사용하여 확인한 것과 유사한 정보이다. PCI Vendor/Device 쌍이 1234:1111로 설정된 것을 확인할 수 있다.

QEMU가 OptionROM 파일을 얻는 방법

OptionROM 이미지 생성을 담당하는 QEMU의 주요 Makefile은 아래 링크로 확인할 수 있다. https://github.com/qemu/qemu/blob/master/roms/Makefile

Makefile에서 방법을 확인할 수 있다.

  • seavgabios-% 타겟은 Legacy SeaVGABIOS OptionROM을 생성하는데 사용된다.

  • efi-rom-% 타겟은 Legacy 및 UEFI iPXE 코드 이미지를 모두 가진 OptionROM을 생성하는데 사용된다.(edk2의 EfiRom 유틸리티를 사용한다.)

OptionROM 이미지의 다양한 CPU 아키텍처에 대한 코드 이미지

이전 장에서 PCI Device가 다양한 CPU 아키텍처를 위한 코드 이미지를 가질 수 있다고 했다.

아래 링크를 예로 든다. https://www.workofard.com/2020/12/aarch64-option-roms-for-amd-gpus/

위 링크에서는 AARCH64 시스템에서 부팅시에 그래픽 카드를 작동시키기 위해 AMD AARCH64 Gop 드라이버를 PCI 그래픽 카드 OptionROM에 추가하는 방법을 설명하고 있다.

flashrom 유틸리티를 사용하여 초기 PCI 카드 Option ROM 펌웨어를 다운로드하고 EfiRom을 통해 AARCH64에 대한 AMD EFI 그래픽 드라이버를 OptionROM 이미지 목록에 추가한다.

Last updated