| 1 |
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nbft_info_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nbft_info_hfi_info_tcp { |
| 6 |
.br |
| 7 |
.BI " __u32 pci_sbdf;" |
| 8 |
.br |
| 9 |
.BI " __u8 mac_addr[6];" |
| 10 |
.br |
| 11 |
.BI " __u16 vlan;" |
| 12 |
.br |
| 13 |
.BI " __u8 ip_origin;" |
| 14 |
.br |
| 15 |
.BI " char ipaddr[40];" |
| 16 |
.br |
| 17 |
.BI " __u8 subnet_mask_prefix;" |
| 18 |
.br |
| 19 |
.BI " char gateway_ipaddr[40];" |
| 20 |
.br |
| 21 |
.BI " __u16 route_metric;" |
| 22 |
.br |
| 23 |
.BI " char primary_dns_ipaddr[40];" |
| 24 |
.br |
| 25 |
.BI " char secondary_dns_ipaddr[40];" |
| 26 |
.br |
| 27 |
.BI " char dhcp_server_ipaddr[40];" |
| 28 |
.br |
| 29 |
.BI " char *host_name;" |
| 30 |
.br |
| 31 |
.BI " bool this_hfi_is_default_route;" |
| 32 |
.br |
| 33 |
.BI " bool dhcp_override;" |
| 34 |
.br |
| 35 |
.BI " |
| 36 |
}; |
| 37 |
.br |
| 38 |
|
| 39 |
.SH Members |
| 40 |
.IP "pci_sbdf" 12 |
| 41 |
PCI Express Routing ID for the HFI Transport Function. |
| 42 |
.IP "mac_addr" 12 |
| 43 |
MAC Address: The MAC address of this HFI, |
| 44 |
in EUI-48TM format. |
| 45 |
.IP "vlan" 12 |
| 46 |
The VLAN identifier if the VLAN is associated with |
| 47 |
this HFI, as defined in IEEE 802.1q-2018 or zeroes |
| 48 |
if no VLAN is associated with this HFI. |
| 49 |
.IP "ip_origin" 12 |
| 50 |
The source of Ethernet L3 configuration information |
| 51 |
used by the driver or 0 if not used. |
| 52 |
.IP "ipaddr" 12 |
| 53 |
The IPv4 or IPv6 address of this HFI. |
| 54 |
.IP "subnet_mask_prefix" 12 |
| 55 |
The IPv4 or IPv6 subnet mask in CIDR routing prefix |
| 56 |
notation. |
| 57 |
.IP "gateway_ipaddr" 12 |
| 58 |
The IPv4 or IPv6 address of the IP gateway for this |
| 59 |
HFI or zeroes if no IP gateway is specified. |
| 60 |
.IP "route_metric" 12 |
| 61 |
The cost value for the route indicated by this HFI. |
| 62 |
.IP "primary_dns_ipaddr" 12 |
| 63 |
The IPv4 or IPv6 address of the Primary DNS server |
| 64 |
for this HFI. |
| 65 |
.IP "secondary_dns_ipaddr" 12 |
| 66 |
The IPv4 or IPv6 address of the Secondary DNS server |
| 67 |
for this HFI. |
| 68 |
.IP "dhcp_server_ipaddr" 12 |
| 69 |
The IPv4 or IPv6 address of the DHCP server used |
| 70 |
to assign this HFI address. |
| 71 |
.IP "host_name" 12 |
| 72 |
The Host Name string. |
| 73 |
.IP "this_hfi_is_default_route" 12 |
| 74 |
If True, then the BIOS utilized this interface |
| 75 |
described by HFI to be the default route with highest |
| 76 |
priority. If False, then routes are local to their |
| 77 |
own scope. |
| 78 |
.IP "dhcp_override" 12 |
| 79 |
If True, then HFI information was populated |
| 80 |
by consuming the DHCP on this interface. If False, |
| 81 |
then the HFI information was set administratively |
| 82 |
by a configuration interface to the driver and |
| 83 |
pre-OS envrionment. |