Debian Codegraph @

doc/man/nbft_header.2

raw
1 .TH "libnvme" 9 "struct nbft_header" "November 2025" "API Manual" LINUX
2 .SH NAME
3 struct nbft_header \- NBFT Table - Header (Figure 8)
4 .SH SYNOPSIS
5 struct nbft_header {
6 .br
7 .BI " char signature[4];"
8 .br
9 .BI " __le32 length;"
10 .br
11 .BI " __u8 major_revision;"
12 .br
13 .BI " __u8 checksum;"
14 .br
15 .BI " char oem_id[6];"
16 .br
17 .BI " char oem_table_id[8];"
18 .br
19 .BI " __le32 oem_revision;"
20 .br
21 .BI " __le32 creator_id;"
22 .br
23 .BI " __le32 creator_revision;"
24 .br
25 .BI " __le32 heap_offset;"
26 .br
27 .BI " __le32 heap_length;"
28 .br
29 .BI " struct nbft_heap_obj driver_dev_path_sig;"
30 .br
31 .BI " __u8 minor_revision;"
32 .br
33 .BI " __u8 reserved[13];"
34 .br
35 .BI "
36 };
37 .br
38
39 .SH Members
40 .IP "signature" 12
41 Signature: An ASCII string representation of the table
42 identifier. This field shall be set to the value 4E424654h
43 (i.e. "NBFT", see #NBFT_HEADER_SIG).
44 .IP "length" 12
45 Length: The length of the table, in bytes, including the
46 header, starting from offset 0h. This field is used to record
47 the size of the entire table.
48 .IP "major_revision" 12
49 Major Revision: The major revision of the structure
50 corresponding to the Signature field. Larger major revision
51 numbers should not be assumed backward compatible to lower
52 major revision numbers with the same signature.
53 .IP "checksum" 12
54 Checksum: The entire table, including the Checksum field,
55 shall sum to 0h to be considered valid.
56 .IP "oem_id" 12
57 OEMID shall be populated by the NBFT driver writer by
58 an OEM-supplied string that identifies the OEM. All
59 trailing bytes shall be NULL.
60 .IP "oem_table_id" 12
61 OEM Table ID: This field shall be populated by the NBFT
62 driver writer with an OEM-supplied string that the OEM
63 uses to identify the particular data table. This field is
64 particularly useful when defining a definition block to
65 distinguish definition block functions. The OEM assigns
66 each dissimilar table a new OEM Table ID.
67 .IP "oem_revision" 12
68 OEM Revision: An OEM-supplied revision number. Larger
69 numbers are assumed to be newer revisions.
70 .IP "creator_id" 12
71 Creator ID: Vendor ID of utility that created the table.
72 For instance, this may be the ID for the ASL Compiler.
73 .IP "creator_revision" 12
74 Creator Revision: Revision of utility that created the
75 table. For instance, this may be the ID for the ASL Compiler.
76 .IP "heap_offset" 12
77 Heap Offset (HO): This field indicates the offset in bytes
78 of the heap, if any, from byte offset 0h of the NBFT
79 Table Header.
80 .IP "heap_length" 12
81 Heap Length (HL): The length of the heap, if any.
82 .IP "driver_dev_path_sig" 12
83 Driver Signature Heap Object Reference: This field indicates
84 the offset in bytes of a heap object containing the Driver
85 Signature, if any, from byte offset 0h of the NBFT Table
86 Header.
87 .IP "minor_revision" 12
88 Minor Revision: The minor revision of the structure
89 corresponding to the Signature field. If the major revision
90 numbers are the same, any minor revision number differences
91 shall be backwards compatible with the same signature.
92 .IP "reserved" 12
93 Reserved.