Debian Codegraph @

doc/man/nbft_hfi_info_tcp.2

raw
1 .TH "libnvme" 9 "struct nbft_hfi_info_tcp" "November 2025" "API Manual" LINUX
2 .SH NAME
3 struct nbft_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP (Figure 13)
4 .SH SYNOPSIS
5 struct nbft_hfi_info_tcp {
6 .br
7 .BI " __u8 structure_id;"
8 .br
9 .BI " __u8 version;"
10 .br
11 .BI " __u8 trtype;"
12 .br
13 .BI " __u8 trinfo_version;"
14 .br
15 .BI " __le16 hfi_index;"
16 .br
17 .BI " __u8 flags;"
18 .br
19 .BI " __le32 pci_sbdf;"
20 .br
21 .BI " __u8 mac_addr[6];"
22 .br
23 .BI " __le16 vlan;"
24 .br
25 .BI " __u8 ip_origin;"
26 .br
27 .BI " __u8 ip_address[16];"
28 .br
29 .BI " __u8 subnet_mask_prefix;"
30 .br
31 .BI " __u8 ip_gateway[16];"
32 .br
33 .BI " __u8 reserved1;"
34 .br
35 .BI " __le16 route_metric;"
36 .br
37 .BI " __u8 primary_dns[16];"
38 .br
39 .BI " __u8 secondary_dns[16];"
40 .br
41 .BI " __u8 dhcp_server[16];"
42 .br
43 .BI " struct nbft_heap_obj host_name_obj;"
44 .br
45 .BI " __u8 reserved2[18];"
46 .br
47 .BI "
48 };
49 .br
50
51 .SH Members
52 .IP "structure_id" 12
53 Structure ID: This field shall be set to 7h (i.e.,
54 HFI Transport Info; #NBFT_DESC_HFI_TRINFO).
55 .IP "version" 12
56 Version: This field shall be set to 1h.
57 .IP "trtype" 12
58 HFI Transport Type, see \fIenum nbft_trtype\fP: This field
59 shall be set to 03h (i.e., NVMe/TCP; #NBFT_TRTYPE_TCP).
60 .IP "trinfo_version" 12
61 Transport Info Version: Implementations compliant to this
62 specification shall set this field to 1h.
63 .IP "hfi_index" 12
64 HFI Descriptor Index: The value of the HFI Descriptor Index
65 field of the HFI Descriptor (see \fIstruct nbft_hfi\fP.index)
66 whose HFI Transport Info Descriptor Heap Object Reference
67 field indicates this HFI Transport Info Descriptor.
68 .IP "flags" 12
69 HFI Transport Flags, see \fIenum nbft_hfi_info_tcp_flags\fP.
70 .IP "pci_sbdf" 12
71 PCI Express Routing ID for the HFI Transport Function:
72 This field indicates the PCI Express Routing ID as specified
73 in the PCI Express Base Specification.
74 .IP "mac_addr" 12
75 MAC Address: The MAC address of this HFI, in EUI-48TM format,
76 as defined in the IEEE Guidelines for Use of Extended Unique
77 Identifiers. This field shall be set to a non-zero value.
78 .IP "vlan" 12
79 VLAN: If this field is set to a non-zero value, then this
80 field contains the VLAN identifier if the VLAN associated
81 with this HFI, as defined in IEEE 802.1q-2018. If no VLAN
82 is associated with this HFI, then this field shall be cleared
83 to 0h.
84 .IP "ip_origin" 12
85 IP Origin: If this field is set to a non-zero value, then
86 this field indicates the source of Ethernet L3 configuration
87 information used by the driver for this interface. Valid
88 values are defined in the Win 32 API: NL_PREFIX_ORIGIN
89 enumeration specification. This field should be cleared
90 to 0h if the IP Origin field is unused by driver.
91 .IP "ip_address" 12
92 IP Address: This field indicates the IPv4 or IPv6 address
93 of this HFI. This field shall be set to a non-zero value.
94 .IP "subnet_mask_prefix" 12
95 Subnet Mask Prefix: This field indicates the IPv4 or IPv6
96 subnet mask in CIDR routing prefix notation.
97 .IP "ip_gateway" 12
98 IP Gateway: If this field is set to a non-zero value, this
99 field indicates the IPv4 or IPv6 address of the IP gateway
100 for this HFI. If this field is cleared to 0h, then
101 no IP gateway is specified.
102 .IP "reserved1" 12
103 Reserved.
104 .IP "route_metric" 12
105 Route Metric: If this field is set to a non-zero value,
106 this field indicates the cost value for the route indicated
107 by this HF. This field contains the value utilized by the
108 pre-OS driver when chosing among all available routes. Lower
109 values relate to higher priority. Refer to IETF RFC 4249.
110 If the pre-OS driver supports routing and did not configure
111 a specific route metric for this interface, then the pre-OS
112 driver should set this value to 500. If the pre-OS driver
113 does not support routing, then this field should be cleared
114 to 0h.
115 .IP "primary_dns" 12
116 Primary DNS: If this field is set to a non-zero value,
117 this field indicates the IPv4 or IPv6 address of the
118 Primary DNS server for this HFI, if any, from byte offset
119 0h of the NBFT Table Header. If this field is cleared to 0h,
120 then no Primary DNS is specified.
121 .IP "secondary_dns" 12
122 Secondary DNS: If this field is set to a non-zero value,
123 this field indicates the IPv4 or IPv6 address of
124 the Secondary DNS server for this HFI, if any, from byte
125 offset 0h of the NBFT Table Header. If this field is
126 cleared to 0h, then no Secondary DNS is specified.
127 .IP "dhcp_server" 12
128 DHCP Server: If the DHCP Override bit is set to 1h, then
129 this field indicates the IPv4 or IPv6 address of the DHCP
130 server used to assign this HFI address. If that bit is
131 cleared to 0h, then this field is reserved.
132 .IP "host_name_obj" 12
133 Host Name Heap Object Reference: If this field is set
134 to a non-zero value, then this field indicates the location
135 and size of a heap object containing a Host Name string.
136 .IP "reserved2" 12
137 Reserved.