tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: sysfs-block: Clarify integrity sysfs attributes

The /sys/block/<disk>/integrity fields are historically set
if T10 protection Information is enabled.

It is not set if some upper layer uses integrity metadata.
Document it.

Signed-off-by: Milan Broz <gmazyland@gmail.com>
Co-developed-by: Martin K. Petersen <martin.petersen@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Link: https://lore.kernel.org/r/20250318154447.370786-1-gmazyland@gmail.com
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Milan Broz and committed by
Jens Axboe fc22b34e 03c90afb

+22 -1
+22 -1
Documentation/ABI/stable/sysfs-block
··· 109 109 Description: 110 110 Indicates whether a storage device is capable of storing 111 111 integrity metadata. Set if the device is T10 PI-capable. 112 + This flag is set to 1 if the storage media is formatted 113 + with T10 Protection Information. If the storage media is 114 + not formatted with T10 Protection Information, this flag 115 + is set to 0. 112 116 113 117 114 118 What: /sys/block/<disk>/integrity/format ··· 121 117 Description: 122 118 Metadata format for integrity capable block device. 123 119 E.g. T10-DIF-TYPE1-CRC. 120 + This field describes the type of T10 Protection Information 121 + that the block device can send and receive. 122 + If the device can store application integrity metadata but 123 + no T10 Protection Information profile is used, this field 124 + contains "nop". 125 + If the device does not support integrity metadata, this 126 + field contains "none". 124 127 125 128 126 129 What: /sys/block/<disk>/integrity/protection_interval_bytes ··· 153 142 Contact: Martin K. Petersen <martin.petersen@oracle.com> 154 143 Description: 155 144 Number of bytes of integrity tag space available per 156 - 512 bytes of data. 145 + protection_interval_bytes, which is typically 146 + the device's logical block size. 147 + This field describes the size of the application tag 148 + if the storage device is formatted with T10 Protection 149 + Information and permits use of the application tag. 150 + The tag_size is reported in bytes and indicates the 151 + space available for adding an opaque tag to each block 152 + (protection_interval_bytes). 153 + If the device does not support T10 Protection Information 154 + (even if the device provides application integrity 155 + metadata space), this field is set to 0. 157 156 158 157 159 158 What: /sys/block/<disk>/integrity/write_generate