[mirror_ubuntu-jammy-kernel.git] / include / linux / t10-pi.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_T10_PI_H
#define _LINUX_T10_PI_H

#include <linux/types.h>
#include <linux/blkdev.h>

/*
 * A T10 PI-capable target device can be formatted with different
 * protection schemes.	Currently 0 through 3 are defined:
 *
 * Type 0 is regular (unprotected) I/O
 *
 * Type 1 defines the contents of the guard and reference tags
 *
 * Type 2 defines the contents of the guard and reference tags and
 * uses 32-byte commands to seed the latter
 *
 * Type 3 defines the contents of the guard tag only
 */
enum t10_dif_type {
	T10_PI_TYPE0_PROTECTION = 0x0,
	T10_PI_TYPE1_PROTECTION = 0x1,
	T10_PI_TYPE2_PROTECTION = 0x2,
	T10_PI_TYPE3_PROTECTION = 0x3,
};

/*
 * T10 Protection Information tuple.
 */
struct t10_pi_tuple {
	__be16 guard_tag;	/* Checksum */
	__be16 app_tag;		/* Opaque storage */
	__be32 ref_tag;		/* Target LBA or indirect LBA */
};

#define T10_PI_APP_ESCAPE cpu_to_be16(0xffff)
#define T10_PI_REF_ESCAPE cpu_to_be32(0xffffffff)

static inline u32 t10_pi_ref_tag(struct request *rq)
{
	unsigned int shift = ilog2(queue_logical_block_size(rq->q));

#ifdef CONFIG_BLK_DEV_INTEGRITY
	if (rq->q->integrity.interval_exp)
		shift = rq->q->integrity.interval_exp;
#endif
	return blk_rq_pos(rq) >> (shift - SECTOR_SHIFT) & 0xffffffff;
}

extern const struct blk_integrity_profile t10_pi_type1_crc;
extern const struct blk_integrity_profile t10_pi_type1_ip;
extern const struct blk_integrity_profile t10_pi_type3_crc;
extern const struct blk_integrity_profile t10_pi_type3_ip;

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
2341c2f8 MP	2	#ifndef _LINUX_T10_PI_H
	3	#define _LINUX_T10_PI_H
	4
	5	#include <linux/types.h>
	6	#include <linux/blkdev.h>
	7
8475c811 CH	8	/*
	9	* A T10 PI-capable target device can be formatted with different
	10	* protection schemes. Currently 0 through 3 are defined:
	11	*
	12	* Type 0 is regular (unprotected) I/O
	13	*
	14	* Type 1 defines the contents of the guard and reference tags
	15	*
	16	* Type 2 defines the contents of the guard and reference tags and
	17	* uses 32-byte commands to seed the latter
	18	*
	19	* Type 3 defines the contents of the guard tag only
	20	*/
	21	enum t10_dif_type {
	22	T10_PI_TYPE0_PROTECTION = 0x0,
	23	T10_PI_TYPE1_PROTECTION = 0x1,
	24	T10_PI_TYPE2_PROTECTION = 0x2,
	25	T10_PI_TYPE3_PROTECTION = 0x3,
	26	};
	27
2341c2f8 MP	28	/*
	29	* T10 Protection Information tuple.
	30	*/
	31	struct t10_pi_tuple {
	32	__be16 guard_tag; /* Checksum */
	33	__be16 app_tag; /* Opaque storage */
	34	__be32 ref_tag; /* Target LBA or indirect LBA */
	35	};
	36
128b6f9f DM	37	#define T10_PI_APP_ESCAPE cpu_to_be16(0xffff)
128b6f9f DM	38	#define T10_PI_REF_ESCAPE cpu_to_be32(0xffffffff)
2341c2f8	39
ddd0bc75 MG	40	static inline u32 t10_pi_ref_tag(struct request *rq)
ddd0bc75 MG	41	{
60a89a3c MP	42	unsigned int shift = ilog2(queue_logical_block_size(rq->q));
60a89a3c MP	43
ddd0bc75	44	#ifdef CONFIG_BLK_DEV_INTEGRITY
60a89a3c MP	45	if (rq->q->integrity.interval_exp)
60a89a3c MP	46	shift = rq->q->integrity.interval_exp;
ddd0bc75	47	#endif
60a89a3c	48	return blk_rq_pos(rq) >> (shift - SECTOR_SHIFT) & 0xffffffff;
ddd0bc75 MG	49	}
ddd0bc75 MG	50
869ab90f EB	51	extern const struct blk_integrity_profile t10_pi_type1_crc;
	52	extern const struct blk_integrity_profile t10_pi_type1_ip;
	53	extern const struct blk_integrity_profile t10_pi_type3_crc;
	54	extern const struct blk_integrity_profile t10_pi_type3_ip;
08fcf813	55
2341c2f8	56	#endif