1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_BLK_INTEGRITY_H
3 #define _LINUX_BLK_INTEGRITY_H
5 #include <linux/blk-mq.h>
9 enum blk_integrity_flags {
10 BLK_INTEGRITY_VERIFY = 1 << 0,
11 BLK_INTEGRITY_GENERATE = 1 << 1,
12 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
13 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
16 struct blk_integrity_iter {
20 unsigned int data_size;
21 unsigned short interval;
22 const char *disk_name;
25 typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
26 typedef void (integrity_prepare_fn) (struct request *);
27 typedef void (integrity_complete_fn) (struct request *, unsigned int);
29 struct blk_integrity_profile {
30 integrity_processing_fn *generate_fn;
31 integrity_processing_fn *verify_fn;
32 integrity_prepare_fn *prepare_fn;
33 integrity_complete_fn *complete_fn;
37 #ifdef CONFIG_BLK_DEV_INTEGRITY
38 void blk_integrity_register(struct gendisk *, struct blk_integrity *);
39 void blk_integrity_unregister(struct gendisk *);
40 int blk_integrity_compare(struct gendisk *, struct gendisk *);
41 int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
42 struct scatterlist *);
43 int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
45 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
47 struct blk_integrity *bi = &disk->queue->integrity;
55 static inline struct blk_integrity *
56 bdev_get_integrity(struct block_device *bdev)
58 return blk_get_integrity(bdev->bd_disk);
62 blk_integrity_queue_supports_integrity(struct request_queue *q)
64 return q->integrity.profile;
67 static inline void blk_queue_max_integrity_segments(struct request_queue *q,
70 q->limits.max_integrity_segments = segs;
73 static inline unsigned short
74 queue_max_integrity_segments(const struct request_queue *q)
76 return q->limits.max_integrity_segments;
80 * bio_integrity_intervals - Return number of integrity intervals for a bio
81 * @bi: blk_integrity profile for device
82 * @sectors: Size of the bio in 512-byte sectors
84 * Description: The block layer calculates everything in 512 byte
85 * sectors but integrity metadata is done in terms of the data integrity
86 * interval size of the storage device. Convert the block layer sectors
87 * to the appropriate number of integrity intervals.
89 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
92 return sectors >> (bi->interval_exp - 9);
95 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
98 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
101 static inline bool blk_integrity_rq(struct request *rq)
103 return rq->cmd_flags & REQ_INTEGRITY;
107 * Return the first bvec that contains integrity data. Only drivers that are
108 * limited to a single integrity segment should use this helper.
110 static inline struct bio_vec *rq_integrity_vec(struct request *rq)
112 if (WARN_ON_ONCE(queue_max_integrity_segments(rq->q) > 1))
114 return rq->bio->bi_integrity->bip_vec;
116 #else /* CONFIG_BLK_DEV_INTEGRITY */
117 static inline int blk_rq_count_integrity_sg(struct request_queue *q,
122 static inline int blk_rq_map_integrity_sg(struct request_queue *q,
124 struct scatterlist *s)
128 static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
132 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
137 blk_integrity_queue_supports_integrity(struct request_queue *q)
141 static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
145 static inline void blk_integrity_register(struct gendisk *d,
146 struct blk_integrity *b)
149 static inline void blk_integrity_unregister(struct gendisk *d)
152 static inline void blk_queue_max_integrity_segments(struct request_queue *q,
156 static inline unsigned short
157 queue_max_integrity_segments(const struct request_queue *q)
162 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
163 unsigned int sectors)
168 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
169 unsigned int sectors)
173 static inline int blk_integrity_rq(struct request *rq)
178 static inline struct bio_vec *rq_integrity_vec(struct request *rq)
182 #endif /* CONFIG_BLK_DEV_INTEGRITY */
183 #endif /* _LINUX_BLK_INTEGRITY_H */