EFI中的CR (CONTAINING RECORD)

在EFI中常常可以見到CR這個define，而這個define的作用是，當擁有某個結構成員的位址時，但卻不知整個結構的頭在哪裡的時候，就可利用這個方法來取得整個結構所在的位址，此為CR的定義：
#define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
Record：為該成員的位址
TYPE：為該結構的型態
Field：為在結構中指向的該成員

這個方法可以分開兩段來看：
(CHAR8 *) (Record)：該成員的實際位址
(CHAR8 *) &(((TYPE *) 0)->Field)：該成員在結構中的偏移量

兩個做相減之後便可取得結構頭的位址，最後再來個(TYPE *)作強制轉換。

PCI I/O Protocols

若要對PCI Device進行讀寫的動作時，可以使用EFI_PCI_IO_PROTOCOL所提供的Function來簡化以前所要做的步驟，以下是PCI IO Protocol的結構：
typedef struct _EFI_PCI_IO_PROTOCOL {
　EFI_PCI_IO_PROTOCOL_POLL_IO_MEM PollMem;
　EFI_PCI_IO_PROTOCOL_POLL_IO_MEM PollIo;
　EFI_PCI_IO_PROTOCOL_ACCESS Mem;
　EFI_PCI_IO_PROTOCOL_ACCESS Io;
　EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS Pci;
　EFI_PCI_IO_PROTOCOL_COPY_MEM CopyMem;
　EFI_PCI_IO_PROTOCOL_MAP Map;
　EFI_PCI_IO_PROTOCOL_UNMAP Unmap;
　EFI_PCI_IO_PROTOCOL_ALLOCATE_BUFFER AllocateBuffer;
　EFI_PCI_IO_PROTOCOL_FREE_BUFFER FreeBuffer;
　EFI_PCI_IO_PROTOCOL_FLUSH Flush;
　EFI_PCI_IO_PROTOCOL_GET_LOCATION GetLocation;
　EFI_PCI_IO_PROTOCOL_ATTRIBUTES Attributes;
　EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES GetBarAttributes;
　EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES SetBarAttributes;
　UINT64 RomSize;
　VOID *RomImage;
} EFI_PCI_IO_PROTOCOL;

// ++++++++++PCI Configuration Space++++++++++
首先來講如何取得PCI Configuration Space：

以上為PCI Configuration Space配置表Type 0。

先使用LocateHandleBuffer，將所有PCI Device的Handle全都找出來：
gBS->LocateHandleBuffer (ByProtocol, &gEfiPciIoProtocolGuid, NULL, &PciHandleCount, &PciHandleBuffer);

隨後在指定的Handle中將PCI IO Protocol找出來：
gBS->OpenProtocol (PciHandle, &gEfiPciIoProtocolGuid, &PciIo, ImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);

以下可取得PCI Device的四個參數：
UINTN Seg;
UINTN Bus;
UINTN Device;
UINTN Function;
PciIo->GetLocation (PciIo, &Seg, &Bus, &Device, &Function);

若要取得整張配置表可以宣告此union型別變數：
typedef union {
　PCI_TYPE00 Device;
　PCI_TYPE01 Bridge;
} PCI_TYPE_GENERIC;
可用其Header Type來判斷它是Device或Bridge，00h與01h...等。

typedef struct {
　PCI_DEVICE_INDEPENDENT_REGION Hdr;
　PCI_DEVICE_HEADER_TYPE_REGION Device;
} PCI_TYPE00;

typedef struct {
　PCI_DEVICE_INDEPENDENT_REGION Hdr;
　PCI_BRIDGE_CONTROL_REGISTER Bridge;
} PCI_TYPE01;

PCI_DEVICE_INDEPENDENT_REGION、PCI_DEVICE_HEADER_TYPE_REGION、PCI_BRIDGE_CONTROL_REGISTER
這三個結構定義可看Spec。

宣告一個PCI_TYPE_GENERIC變數
PCI_TYPE_GENERIC Pci;
PciIo->Pci.Read (PciIo, EfiPciWidthUint32, 0, sizeof (PCI_TYPE_GENERIC) / sizeof (UINT32), &Pci);
第二個參數可以設定每次所要取得的大小，詳情可看其定義。
第三個參數為起始位址，由於要抓整張表所以便填入0。
第四個參數為總共要抓取的次數。
成功後可一一取值，如：
Pci.Device.Hdr.VendorId;
Pci.Device.Device.SubsystemVendorID;

若要取得配置表的其中一個值，可先算出所在位址，如Status位址在06h而大小是16bits，先宣告一個UINT16的變數Status，代入Pci.Read()。
PciIo->Pci.Read (PciIo, EfiPciWidthUint16, 0, 1, &Status);

如果要取得ClassCode的話，而它是3個8bits整數，所以宣告一個UINT8 ClassCode[3]陣列，再呼叫Pci.Read()。
PciIo->Pci.Read (PciIo, EfiPciWidthUint8, 0, 3, ClassCode);

以下可印出整張表的內容：
UINT8 Content;
for (i = 0x00; i <= 0x0F; ++i) { 　for (j = 0x00; j <= 0x0F; ++j) { 　　Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, ((i * 0x10) + j), sizeof (Content), &Content);
　　PrintAt (j * 3, i, L"%02x", Content);
　}
}

// ++++++++++PCI Base Address Register++++++++++
接下來是Base Address Register的部分，一般PCI Device共有六個BAR，而PCI/PCI Bridge只有兩個BAR，可看Spec。
而BAR又分了IO Space與Memory Space兩種方式，可看其第一個bit決定，0是Memory Space而1是IO Space，也就是基偶之分，EFI也提供了一個結構儲存該BAR的屬性。
typedef struct {
　UINT8 Desc;
　UINT16 Len;
　UINT8 ResType;
　UINT8 GenFlag;
　UINT8 SpecificFlag;
　UINT64 AddrSpaceGranularity;
　UINT64 AddrRangeMin;
　UINT64 AddrRangeMax;
　UINT64 AddrTranslationOffset;
　UINT64 AddrLen;
} EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR;

此時宣告其指標：
EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Resources;
PciIo->GetBarAttributes (PciIo, PciBarIndex, NULL, &Resources);
注意用完Resources後要釋放掉。

Resources->ResType也可判斷BAR的屬性（IO/Memory）。
if (Resources->ResType == 0) {
　PciIo->Mem.Read(PciIo, EfiPciIoWidthUint8, PciBarIndex,0, sizeof (Content), &Content);
} else {
　PciIo->Io.Read(PciIo, EfiPciIoWidthUint8, PciBarIndex, 0, sizeof (Content), &Content);
}
BarIndex按自己所需的BAR代入0~5(P2P Bridge: 0~1)的整數。
至於寫入也是相同方式。

Variable Service

EFI BIOS使用Variable來儲存各個配置設定，通常存放於NVRAM或CMOS中，這部分就看IBV如何訂定，在DXE階段後可使用Runtime Services所提供的三個服務來存取Variable，基本上一個Variable是由Name、GUID與Data所組成，但其在記憶體中並沒有一定的順序性，所以要找到一個Data就得靠Name和GUID所提供的Index來取得，先介紹這三個Services。

GetNextVariableName(
IN OUT UINTN *VariableNameSize,
IN OUT CHAR16 *VariableName,
IN OUT EFI_GUID *VendorGuid
);
可以透過傳進去的Name與GUID來得到它下一個Name與GUID，並傳出Name的實際Size，如果您不知道任何的Name與GUID的話，此時可填入空的Name與GUID，便會將第一組傳回。

GetVariable(
　IN CHAR16 *VariableName,
　IN EFI_GUID *VendorGuid,
　OUT UINT32 *Attributes OPTIONAL,
　IN OUT UINTN *DataSize,
　OUT VOID *Data
);
可傳回對應Name與GUID的Data，要傳出的Data要先為它配置好一個空間（動態或靜態皆可），如果不知道Data的Size，此時可先傳入一個非0的Size，它會將實際的Size傳出，並傳回EFI_BUFFER_TOO_SMALL的錯誤訊息，接下來再動態配置空間即可。

SetVariable(
　IN CHAR16 *VariableName,
　IN EFI_GUID *VendorGuid,
　IN UINT32 Attributes,
　IN UINTN DataSize,
　IN VOID *Data
);
將傳入的Data寫入至對應的Name與GUID。

Attributes:
#define EFI_VARIABLE_NON_VOLATILE 0x00000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010