Intel Extensible Firmware Interface

To Next Page

To Previous Page

PXE Base Code Protocol

Version 1.02 12/12/00 249

Status Codes Returned

EFI_SUCCESS The PXE Base Code Protocol was started.

EFI_INVALID_PARAMETER One of the parameters is not valid.

EFI_UNSUPPORTED

UseIpv6 is TRUE, but the Ipv6Supported field of the

EFI_BASE_CODE_MODE structure is FALSE.

EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.

EFI_DEVICE_ERROR The network device encountered an error during this operation.

EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the

PXE Base Code Protocol.

Main Page

Default Chapter3
- Revision History3
- Table of Contents5
Tables20
- Overview20
  - Organization of EFI Specification20
1 Introduction21
- Goals21
- Target Audience23
- Related Information24
- Prerequisite Specifications26
  - ACPI Specification26
  - Wfm Specification26
- EFI Design Overview27
- Figures28
- Migration Requirements29
- Conventions Used in this Document30
- Guidelines for Use of the Term "Extensible Firmware Interface30
2 Overview32
Boot Manager32
- Firmware Core32
  - EFI Services32
- EFI Runtime Services33
- Calling Conventions34
- Protocols37
- Requirements39
- TPL Usage45
- TPL Restrictions46
3 Services47
- Memory Allocation Functions60
- Memory Allocation Services60
- Memory Type Usage before Exitbootservices()61
- Memory Type Usage after Exitbootservices()62
- Protocol Handler Services73
- Protocol Interface Functions73
- Image Services85
- Image Type Differences Summary85
- Image Functions86
- Variable Services Functions95
- Time Services Functions102
- Virtual Memory Functions109
- Miscellaneous Services Functions113
4 EFI Image123
- LOADED_IMAGE Protocol123
  - Loaded_Image.unload()126
- EFI Image Header127
- EFI Applications128
- EFI os Loaders128
- EFI Drivers128
  - EFI Image Handoff State129
    - IA-32 Handoff State133
- Stack after Imageentrypoint Called, IA-32133
  - Handoff State, Itanium-Based Operating Systems134
- Stack after Imageentrypoint Called, Itanium-Based Systems134
- Device Path Overview135
Device Path Protocol135
- EFI_DEVICE_PATH Protocol136
- Device Path Nodes137
- Generic Device Path Node Structure137
  - Hardware Device Path138
- Generic Device Path Structures137
- Device Path End Structure138
- PCCARD Device Path139
- PCI Device Path139
- Controller Device Path140
  - Messaging Device Path141
- Memory Mapped Device Path140
- Vendor Device Path140
- Vendor-Defined Device Path140
- ACPI Device Path141
- ATAPI Device Path142
- Fibre Channel Device Path142
- SCSI Device Path142
- 1394 Device Path143
- USB Device Path143
- I O Device Path144
- MAC Address Device Path144
- USB Class Device Path144
- Ipv4 Device Path145
- Ipv6 Device Path145
- Infiniband † Device Path146
- UART Device Path146
  - Media Device Path147
    - Hard Drive147
- Vendor-Defined Messaging Device Path147
- Hard Drive Media Device Path148
- CD-ROM Media Device Path149
  - Media Protocol Device Path150
- Vendor-Defined Media Device Path149
- File Path Media Device Path150
- Media Protocol Media Device Path150
- BIOS Boot Specification Device Path151
  - Rules with ACPI _HID and _UID152
- Device Path Generation Rules151
  - Housekeeping Rules151
- ACPI _CRS to EFI Device Path Mapping152
  - Rules with ACPI _ADR153
  - Hardware Vs. Messaging Device Path Rules153
- ACPI _ADR to EFI Device Path Mapping153
  - Media Device Path Rules154
  - Other Rules154
6 Device I/O Protocol155
- Device I/O Overview155
- DEVICE_IO Protocol155
  - Device_Io.mem(), .Io(), and .Pci()159
- PCI Address160
7 Console I/O Protocol169
- Console I/O Overview169
- Consolein Definition170
- EFI Scan Codes for SIMPLE_INPUT_INTERFACE170
- Supported Unicode Control Characters170
- SIMPLE_INPUT Protocol172
  - Simple_Input.reset()173
  - Simple_Input.readkeystroke174
- Consoleout or Standarderror175
- SIMPLE_TEXT_OUTPUT Protocol175
8 Block I/O Protocol191
- BLOCK_IO Protocol191
9 Disk I/O Protocol201
- DISK_IO Protocol201
  - Efi_Disk_Io.readdisk()203
  - Efi_Disk_Io.writedisk()204
10 File System Protocol205
- Simple File System Protocol205
  - Efi_File_Io_Interface.openvolume()207
- EFI_FILE Protocol208
11 Load File Protocol227
- LOAD_FILE Protocol227
  - Load_File.loadfile()228
12 Serial I/O Protocol231
- SERIAL_IO Protocol231
13 Unicode Collation Protocol243
- UNICODE_COLLATION Protocol243
14 PXE Base Code Protocol35253
- EFI_PXE_BASE_CODE Protocol253
- PXE Tag Definitions for EFI263
- Destination IP Filter Operation282
- Destination UDP Port Filter Operation282
- Source IP Filter Operation283
- Source UDP Port Filter Operation283
- EFI_PXE_BASE_CODE_CALLBACK Protocol291
  - Efi_Pxe_Base_Code_Callback.callback()292
15 Simple Network Protocol295
- EFI_SIMPLE_NETWORK Protocol295
- NETWORK_INTERFACE_IDENTIFIER Protocol320
- System Partition323
File System Format323
- Directory Structure324
- File Names324
- Partition Discovery326
- Nesting of Legacy MBR Partition Records326
  - EFI Partition Header327
- GUID Partition Table (GPT) Scheme328
- GUID Partition Table Header329
- GUID Partition Entry330
- Defined GUID Partition Entry - Attributes331
- Defined GUID Partition Entry - Partition Type Guids331
  - ISO-9660 and el Torito332
  - Legacy Master Boot Record332
- Legacy Master Boot Record333
  - Legacy Master Boot Record and GPT Partitions334
- Legacy Master Boot Record Partition Record333
- PMBR Entry to Precede a GUID Partition Table Header334
- Global Variables341
  - Boot Option Variables Default Behavior343
    - Boot Via Simple File Protocol343
    - Removable Media Boot Behavior343
  - Boot Mechanisms343
- EFI Image Types344
- Standard PCI Expansion ROM Header345
- EFI PCI Expansion ROM Header346
- PCI Data Structure346
E Alphabetic Function Lists377
F Glossary377
- G-1. Definitions391
- G.1 Introduction391
- G.1.1 Definitions391
- G-2. Referenced Specification392
- G.1.2 Referenced Specifications392
- G-1. Network Stacks with Three Classes of Drivers394
- G.1.3 os Network Stacks394
- G-3. Driver Types: Pros and Cons395
- G-2. !PXE Structures for H/W and S/W UNDI396
- G.2 Overview396
- G.2.1 32/64-Bit UNDI Interface396
- G-4. !PXE Structure Field Definitions397
- Issuing UNDI Commands401
  - G-4. UNDI Command Descriptor Block (CDB)402
  - G-5. UNDI CDB Field Definitions402
  - G.2.2 UNDI Command Format402
  - G.3 UNDI C Definitions404
  - G.3.1 Portability Macros404
  - G.3.2 Miscellaneous Macros408
  - G.3.3 Portability Types408
- Storage Types408
  - G.3.4 Simple Types410
  - G.3.5 Compound Types427
  - G-6. UNDI States, Transitions & Valid Commands434
  - G.4 UNDI Commands434
  - G.4.1 Command Linking & Queuing435
- Linked Cdbs435
- G.4.2 Get State436
- Queued Cdbs436
  - G.4.3 Start438
  - G.4.4 Stop440
  - G.4.5 Get Init Info441
  - G.4.6 Get Config Info445
  - G.4.7 Initialize448
  - G.4.8 Reset452
  - G.4.9 Shutdown453
- G.4.10 Interrupt Enables455
- G.4.11 Receive Filters457
- G.4.12 Station Address460
- G.4.13 Statistics462
- G.4.14 Mcast IP to MAC466
- G.4.15 Nvdata467
- G.4.16 Get Status472
- G.4.17 Fill Header474
  - G.4.18 Transmit478
  - G.4.19 Receive482
- UNDI as an EFI Runtime Driver484
Index487

Intel Extensible Firmware Interface - Page 267

Table of Contents

Related product manuals