Data Structures | Data Fields

Format of buffer filled in by pxenv_get_cached_info() More...

#include <pxe_api.h>

Data Structures

union  bootph_vendor
 DHCP options. More...

Data Fields

UINT8_t opcode
 Message opcode. More...
UINT8_t Hardware
 NIC hardware type. More...
UINT8_t Hardlen
 MAC address length. More...
UINT8_t Gatehops
 Gateway hops. More...
UINT32_t ident
 DHCP transaction id (xid) More...
UINT16_t seconds
 Elapsed time. More...
UINT16_t Flags
 Flags. More...
IP4_t cip
 Client IP address. More...
IP4_t yip
 Your IP address. More...
IP4_t sip
 Server IP address. More...
IP4_t gip
 Gateway IP address. More...
 Client MAC address. More...
UINT8_t Sname [64]
 Server host name. More...
UINT8_t bootfile [128]
 Boot file name. More...
union bootph::bootph_vendor vendor

Detailed Description

Format of buffer filled in by pxenv_get_cached_info()

This somewhat convoluted data structure simply describes the layout of a DHCP packet. Refer to RFC2131 section 2 for a full description.

Definition at line 322 of file pxe_api.h.

Field Documentation

◆ opcode

UINT8_t bootph::opcode

Message opcode.

Valid values are BOOTP_REQ and BOOTP_REP.

Definition at line 327 of file pxe_api.h.

◆ Hardware

UINT8_t bootph::Hardware

NIC hardware type.

Valid values are as for s_PXENV_UNDI_GET_INFORMATION::HwType.

Definition at line 332 of file pxe_api.h.

◆ Hardlen

UINT8_t bootph::Hardlen

MAC address length.

Definition at line 333 of file pxe_api.h.

◆ Gatehops

UINT8_t bootph::Gatehops

Gateway hops.

Zero in packets sent by the client. May be non-zero in replies from the DHCP server, if the reply comes via a DHCP relay agent.

Definition at line 340 of file pxe_api.h.

◆ ident

UINT32_t bootph::ident

DHCP transaction id (xid)

Definition at line 341 of file pxe_api.h.

◆ seconds

UINT16_t bootph::seconds

Elapsed time.

Number of seconds since the client began the DHCP transaction.

Definition at line 347 of file pxe_api.h.

◆ Flags

UINT16_t bootph::Flags


This is the bitwise-OR of any of the following values: BOOTP_BCAST.

Definition at line 353 of file pxe_api.h.

◆ cip

IP4_t bootph::cip

Client IP address.

Set only if the client already has an IP address.

Definition at line 358 of file pxe_api.h.

◆ yip

IP4_t bootph::yip

Your IP address.

This is the IP address that the server assigns to the client.

Definition at line 364 of file pxe_api.h.

◆ sip

IP4_t bootph::sip

Server IP address.

This is the IP address of the BOOTP/DHCP server.

Definition at line 369 of file pxe_api.h.

◆ gip

IP4_t bootph::gip

Gateway IP address.

This is the IP address of the BOOTP/DHCP relay agent, if any. It is not (necessarily) the address of the default gateway for routing purposes.

Definition at line 376 of file pxe_api.h.

◆ CAddr

MAC_ADDR_t bootph::CAddr

Client MAC address.

Definition at line 377 of file pxe_api.h.

◆ Sname

UINT8_t bootph::Sname[64]

Server host name.

Definition at line 378 of file pxe_api.h.

◆ bootfile

UINT8_t bootph::bootfile[128]

Boot file name.

Definition at line 379 of file pxe_api.h.

◆ vendor

union bootph::bootph_vendor bootph::vendor

The documentation for this struct was generated from the following file: