[mirror_ubuntu-jammy-kernel.git] / drivers / scsi / sd.h

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

/*
 * More than enough for everybody ;)  The huge number of majors
 * is a leftover from 16bit dev_t days, we don't really need that
 * much numberspace.
 */
#define SD_MAJORS	16

/*
 * Time out in seconds for disks and Magneto-opticals (which are slower).
 */
#define SD_TIMEOUT		(30 * HZ)
#define SD_MOD_TIMEOUT		(75 * HZ)
/*
 * Flush timeout is a multiplier over the standard device timeout which is
 * user modifiable via sysfs but initially set to SD_TIMEOUT
 */
#define SD_FLUSH_TIMEOUT_MULTIPLIER	2
#define SD_WRITE_SAME_TIMEOUT	(120 * HZ)

/*
 * Number of allowed retries
 */
#define SD_MAX_RETRIES		5
#define SD_PASSTHROUGH_RETRIES	1
#define SD_MAX_MEDIUM_TIMEOUTS	2

/*
 * Size of the initial data buffer for mode and read capacity data
 */
#define SD_BUF_SIZE		512

/*
 * Number of sectors at the end of the device to avoid multi-sector
 * accesses to in the case of last_sector_bug
 */
#define SD_LAST_BUGGY_SECTORS	8

enum {
	SD_EXT_CDB_SIZE = 32,	/* Extended CDB size */
	SD_MEMPOOL_SIZE = 2,	/* CDB pool size */
};

enum {
	SD_DEF_XFER_BLOCKS = 0xffff,
	SD_MAX_XFER_BLOCKS = 0xffffffff,
	SD_MAX_WS10_BLOCKS = 0xffff,
	SD_MAX_WS16_BLOCKS = 0x7fffff,
};

enum {
	SD_LBP_FULL = 0,	/* Full logical block provisioning */
	SD_LBP_UNMAP,		/* Use UNMAP command */
	SD_LBP_WS16,		/* Use WRITE SAME(16) with UNMAP bit */
	SD_LBP_WS10,		/* Use WRITE SAME(10) with UNMAP bit */
	SD_LBP_ZERO,		/* Use WRITE SAME(10) with zero payload */
	SD_LBP_DISABLE,		/* Discard disabled due to failed cmd */
};

enum {
	SD_ZERO_WRITE = 0,	/* Use WRITE(10/16) command */
	SD_ZERO_WS,		/* Use WRITE SAME(10/16) command */
	SD_ZERO_WS16_UNMAP,	/* Use WRITE SAME(16) with UNMAP */
	SD_ZERO_WS10_UNMAP,	/* Use WRITE SAME(10) with UNMAP */
};

struct scsi_disk {
	struct scsi_driver *driver;	/* always &sd_template */
	struct scsi_device *device;
	struct device	dev;
	struct gendisk	*disk;
	struct opal_dev *opal_dev;
#ifdef CONFIG_BLK_DEV_ZONED
	u32		nr_zones;
	u32		rev_nr_zones;
	u32		zone_blocks;
	u32		rev_zone_blocks;
	u32		zones_optimal_open;
	u32		zones_optimal_nonseq;
	u32		zones_max_open;
	u32		*zones_wp_offset;
	spinlock_t	zones_wp_offset_lock;
	u32		*rev_wp_offset;
	struct mutex	rev_mutex;
	struct work_struct zone_wp_offset_work;
	char		*zone_wp_update_buf;
#endif
	atomic_t	openers;
	sector_t	capacity;	/* size in logical blocks */
	int		max_retries;
	u32		max_xfer_blocks;
	u32		opt_xfer_blocks;
	u32		max_ws_blocks;
	u32		max_unmap_blocks;
	u32		unmap_granularity;
	u32		unmap_alignment;
	u32		index;
	unsigned int	physical_block_size;
	unsigned int	max_medium_access_timeouts;
	unsigned int	medium_access_timed_out;
	u8		media_present;
	u8		write_prot;
	u8		protection_type;/* Data Integrity Field */
	u8		provisioning_mode;
	u8		zeroing_mode;
	unsigned	ATO : 1;	/* state of disk ATO bit */
	unsigned	cache_override : 1; /* temp override of WCE,RCD */
	unsigned	WCE : 1;	/* state of disk WCE bit */
	unsigned	RCD : 1;	/* state of disk RCD bit, unused */
	unsigned	DPOFUA : 1;	/* state of disk DPOFUA bit */
	unsigned	first_scan : 1;
	unsigned	lbpme : 1;
	unsigned	lbprz : 1;
	unsigned	lbpu : 1;
	unsigned	lbpws : 1;
	unsigned	lbpws10 : 1;
	unsigned	lbpvpd : 1;
	unsigned	ws10 : 1;
	unsigned	ws16 : 1;
	unsigned	rc_basis: 2;
	unsigned	zoned: 2;
	unsigned	urswrz : 1;
	unsigned	security : 1;
	unsigned	ignore_medium_access_errors : 1;
};
#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)

static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
{
	return container_of(disk->private_data, struct scsi_disk, driver);
}

#define sd_printk(prefix, sdsk, fmt, a...)				\
        (sdsk)->disk ?							\
	      sdev_prefix_printk(prefix, (sdsk)->device,		\
				 (sdsk)->disk->disk_name, fmt, ##a) :	\
	      sdev_printk(prefix, (sdsk)->device, fmt, ##a)

#define sd_first_printk(prefix, sdsk, fmt, a...)			\
	do {								\
		if ((sdsk)->first_scan)					\
			sd_printk(prefix, sdsk, fmt, ##a);		\
	} while (0)

static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
{
	switch (scmd->cmnd[0]) {
	case READ_6:
	case READ_10:
	case READ_12:
	case READ_16:
	case SYNCHRONIZE_CACHE:
	case VERIFY:
	case VERIFY_12:
	case VERIFY_16:
	case WRITE_6:
	case WRITE_10:
	case WRITE_12:
	case WRITE_16:
	case WRITE_SAME:
	case WRITE_SAME_16:
	case UNMAP:
		return 1;
	case VARIABLE_LENGTH_CMD:
		switch (scmd->cmnd[9]) {
		case READ_32:
		case VERIFY_32:
		case WRITE_32:
		case WRITE_SAME_32:
			return 1;
		}
	}

	return 0;
}

static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
{
	return blocks << (ilog2(sdev->sector_size) - 9);
}

static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
{
	return blocks * sdev->sector_size;
}

static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
{
	return bytes >> ilog2(sdev->sector_size);
}

static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
{
	return sector >> (ilog2(sdev->sector_size) - 9);
}

#ifdef CONFIG_BLK_DEV_INTEGRITY

extern void sd_dif_config_host(struct scsi_disk *);

#else /* CONFIG_BLK_DEV_INTEGRITY */

static inline void sd_dif_config_host(struct scsi_disk *disk)
{
}

#endif /* CONFIG_BLK_DEV_INTEGRITY */

static inline int sd_is_zoned(struct scsi_disk *sdkp)
{
	return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
}

#ifdef CONFIG_BLK_DEV_ZONED

void sd_zbc_release_disk(struct scsi_disk *sdkp);
int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
					 unsigned char op, bool all);
unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
			     struct scsi_sense_hdr *sshdr);
int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
		unsigned int nr_zones, report_zones_cb cb, void *data);

blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
				        unsigned int nr_blocks);

#else /* CONFIG_BLK_DEV_ZONED */

static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}

static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
				    unsigned char *buf)
{
	return 0;
}

static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
{
	return 0;
}

static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
						       unsigned char op,
						       bool all)
{
	return BLK_STS_TARGET;
}

static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
			unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
{
	return good_bytes;
}

static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
						      sector_t *lba,
						      unsigned int nr_blocks)
{
	return BLK_STS_TARGET;
}

#define sd_zbc_report_zones NULL

#endif /* CONFIG_BLK_DEV_ZONED */

void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);

#endif /* _SCSI_DISK_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
e73aec82 MP	2	#ifndef _SCSI_DISK_H
	3	#define _SCSI_DISK_H
	4
	5	/*
	6	* More than enough for everybody ;) The huge number of majors
	7	* is a leftover from 16bit dev_t days, we don't really need that
	8	* much numberspace.
	9	*/
	10	#define SD_MAJORS 16
	11
e73aec82 MP	12	/*
	13	* Time out in seconds for disks and Magneto-opticals (which are slower).
	14	*/
	15	#define SD_TIMEOUT (30 * HZ)
	16	#define SD_MOD_TIMEOUT (75 * HZ)
7e660100 JB	17	/*
	18	* Flush timeout is a multiplier over the standard device timeout which is
	19	* user modifiable via sysfs but initially set to SD_TIMEOUT
	20	*/
	21	#define SD_FLUSH_TIMEOUT_MULTIPLIER 2
5db44863	22	#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
e73aec82 MP	23
	24	/*
	25	* Number of allowed retries
	26	*/
	27	#define SD_MAX_RETRIES 5
	28	#define SD_PASSTHROUGH_RETRIES 1
18a4d0a2	29	#define SD_MAX_MEDIUM_TIMEOUTS 2
e73aec82 MP	30
	31	/*
	32	* Size of the initial data buffer for mode and read capacity data
	33	*/
	34	#define SD_BUF_SIZE 512
	35
18351070 LT	36	/*
	37	* Number of sectors at the end of the device to avoid multi-sector
	38	* accesses to in the case of last_sector_bug
	39	*/
	40	#define SD_LAST_BUGGY_SECTORS 8
	41
4e7392ec MP	42	enum {
	43	SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
	44	SD_MEMPOOL_SIZE = 2, /* CDB pool size */
	45	};
	46
5db44863	47	enum {
bcdb247c MP	48	SD_DEF_XFER_BLOCKS = 0xffff,
bcdb247c MP	49	SD_MAX_XFER_BLOCKS = 0xffffffff,
5db44863 MP	50	SD_MAX_WS10_BLOCKS = 0xffff,
	51	SD_MAX_WS16_BLOCKS = 0x7fffff,
	52	};
	53
c98a0eb0 MP	54	enum {
	55	SD_LBP_FULL = 0, /* Full logical block provisioning */
	56	SD_LBP_UNMAP, /* Use UNMAP command */
	57	SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */
	58	SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */
	59	SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */
	60	SD_LBP_DISABLE, /* Discard disabled due to failed cmd */
	61	};
	62
e6bd9312 MP	63	enum {
	64	SD_ZERO_WRITE = 0, /* Use WRITE(10/16) command */
	65	SD_ZERO_WS, /* Use WRITE SAME(10/16) command */
	66	SD_ZERO_WS16_UNMAP, /* Use WRITE SAME(16) with UNMAP */
	67	SD_ZERO_WS10_UNMAP, /* Use WRITE SAME(10) with UNMAP */
	68	};
	69
e73aec82 MP	70	struct scsi_disk {
	71	struct scsi_driver driver; / always &sd_template */
	72	struct scsi_device *device;
ee959b00	73	struct device dev;
e73aec82	74	struct gendisk *disk;
d80210f2	75	struct opal_dev *opal_dev;
89d94756	76	#ifdef CONFIG_BLK_DEV_ZONED
354f1132	77	u32 nr_zones;
a3d8a257	78	u32 rev_nr_zones;
354f1132	79	u32 zone_blocks;
a3d8a257	80	u32 rev_zone_blocks;
354f1132 BVA	81	u32 zones_optimal_open;
	82	u32 zones_optimal_nonseq;
	83	u32 zones_max_open;
5795eb44 JT	84	u32 *zones_wp_offset;
	85	spinlock_t zones_wp_offset_lock;
	86	u32 *rev_wp_offset;
	87	struct mutex rev_mutex;
	88	struct work_struct zone_wp_offset_work;
	89	char *zone_wp_update_buf;
89d94756	90	#endif
409f3499	91	atomic_t openers;
f08bb1e0	92	sector_t capacity; /* size in logical blocks */
0610959f	93	int max_retries;
bcdb247c	94	u32 max_xfer_blocks;
ca369d51	95	u32 opt_xfer_blocks;
c98a0eb0 MP	96	u32 max_ws_blocks;
	97	u32 max_unmap_blocks;
	98	u32 unmap_granularity;
	99	u32 unmap_alignment;
e73aec82	100	u32 index;
526f7c79	101	unsigned int physical_block_size;
18a4d0a2 MP	102	unsigned int max_medium_access_timeouts;
18a4d0a2 MP	103	unsigned int medium_access_timed_out;
e73aec82 MP	104	u8 media_present;
e73aec82 MP	105	u8 write_prot;
e0597d70	106	u8 protection_type;/* Data Integrity Field */
c98a0eb0	107	u8 provisioning_mode;
e6bd9312	108	u8 zeroing_mode;
e0597d70	109	unsigned ATO : 1; /* state of disk ATO bit */
39c60a09	110	unsigned cache_override : 1; /* temp override of WCE,RCD */
e73aec82 MP	111	unsigned WCE : 1; /* state of disk WCE bit */
	112	unsigned RCD : 1; /* state of disk RCD bit, unused */
	113	unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
70a9b873	114	unsigned first_scan : 1;
c98a0eb0 MP	115	unsigned lbpme : 1;
	116	unsigned lbprz : 1;
	117	unsigned lbpu : 1;
	118	unsigned lbpws : 1;
	119	unsigned lbpws10 : 1;
	120	unsigned lbpvpd : 1;
66c28f97	121	unsigned ws10 : 1;
5db44863	122	unsigned ws16 : 1;
89d94756 HR	123	unsigned rc_basis: 2;
	124	unsigned zoned: 2;
	125	unsigned urswrz : 1;
d80210f2	126	unsigned security : 1;
7a38dc0b	127	unsigned ignore_medium_access_errors : 1;
e73aec82	128	};
ee959b00	129	#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
e73aec82	130
5b635da1 MP	131	static inline struct scsi_disk scsi_disk(struct gendisk disk)
	132	{
	133	return container_of(disk->private_data, struct scsi_disk, driver);
	134	}
	135
e73aec82 MP	136	#define sd_printk(prefix, sdsk, fmt, a...) \
e73aec82 MP	137	(sdsk)->disk ? \
22e0d994 HR	138	sdev_prefix_printk(prefix, (sdsk)->device, \
	139	(sdsk)->disk->disk_name, fmt, ##a) : \
	140	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
e73aec82	141
b2bff6ce MP	142	#define sd_first_printk(prefix, sdsk, fmt, a...) \
b2bff6ce MP	143	do { \
df46cac3	144	if ((sdsk)->first_scan) \
b2bff6ce MP	145	sd_printk(prefix, sdsk, fmt, ##a); \
	146	} while (0)
	147
18a4d0a2 MP	148	static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
	149	{
	150	switch (scmd->cmnd[0]) {
	151	case READ_6:
	152	case READ_10:
	153	case READ_12:
	154	case READ_16:
	155	case SYNCHRONIZE_CACHE:
	156	case VERIFY:
	157	case VERIFY_12:
	158	case VERIFY_16:
	159	case WRITE_6:
	160	case WRITE_10:
	161	case WRITE_12:
	162	case WRITE_16:
	163	case WRITE_SAME:
	164	case WRITE_SAME_16:
	165	case UNMAP:
	166	return 1;
	167	case VARIABLE_LENGTH_CMD:
	168	switch (scmd->cmnd[9]) {
	169	case READ_32:
	170	case VERIFY_32:
	171	case WRITE_32:
	172	case WRITE_SAME_32:
	173	return 1;
	174	}
	175	}
	176
	177	return 0;
	178	}
	179
f08bb1e0 MP	180	static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
	181	{
	182	return blocks << (ilog2(sdev->sector_size) - 9);
	183	}
	184
6b7e9cde MP	185	static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
	186	{
	187	return blocks * sdev->sector_size;
	188	}
	189
6eadc612 DLM	190	static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
	191	{
	192	return bytes >> ilog2(sdev->sector_size);
	193	}
	194
89d94756 HR	195	static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
	196	{
	197	return sector >> (ilog2(sdev->sector_size) - 9);
	198	}
	199
4c393e6e	200	#ifdef CONFIG_BLK_DEV_INTEGRITY
af55ff67	201
af55ff67	202	extern void sd_dif_config_host(struct scsi_disk *);
af55ff67 MP	203
	204	#else /* CONFIG_BLK_DEV_INTEGRITY */
	205
4c393e6e JB	206	static inline void sd_dif_config_host(struct scsi_disk *disk)
	207	{
	208	}
af55ff67 MP	209
	210	#endif /* CONFIG_BLK_DEV_INTEGRITY */
	211
89d94756 HR	212	static inline int sd_is_zoned(struct scsi_disk *sdkp)
	213	{
	214	return sdkp->zoned == 1 \|\| sdkp->device->type == TYPE_ZBC;
	215	}
	216
	217	#ifdef CONFIG_BLK_DEV_ZONED
	218
5795eb44	219	void sd_zbc_release_disk(struct scsi_disk *sdkp);
a3d8a257 DLM	220	int sd_zbc_read_zones(struct scsi_disk sdkp, unsigned char buffer);
a3d8a257 DLM	221	int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
ad512f20 AJ	222	blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
ad512f20 AJ	223	unsigned char op, bool all);
5795eb44 JT	224	unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
5795eb44 JT	225	struct scsi_sense_hdr *sshdr);
d4100351 CH	226	int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
d4100351 CH	227	unsigned int nr_zones, report_zones_cb cb, void *data);
89d94756	228
5795eb44 JT	229	blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd cmd, sector_t lba,
	230	unsigned int nr_blocks);
	231
89d94756 HR	232	#else /* CONFIG_BLK_DEV_ZONED */
89d94756 HR	233
5795eb44 JT	234	static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
5795eb44 JT	235
89d94756 HR	236	static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
	237	unsigned char *buf)
	238	{
	239	return 0;
	240	}
	241
a3d8a257 DLM	242	static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
	243	{
	244	return 0;
	245	}
89d94756	246
ad512f20 AJ	247	static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
	248	unsigned char op,
	249	bool all)
89d94756	250	{
159b2cbf	251	return BLK_STS_TARGET;
89d94756 HR	252	}
89d94756 HR	253
5795eb44 JT	254	static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
	255	unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
	256	{
27ba3e8f	257	return good_bytes;
5795eb44 JT	258	}
	259
	260	static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
	261	sector_t *lba,
	262	unsigned int nr_blocks)
	263	{
	264	return BLK_STS_TARGET;
	265	}
89d94756	266
e76239a3 CH	267	#define sd_zbc_report_zones NULL
e76239a3 CH	268
89d94756 HR	269	#endif /* CONFIG_BLK_DEV_ZONED */
89d94756 HR	270
a35989a0 DLM	271	void sd_print_sense_hdr(struct scsi_disk sdkp, struct scsi_sense_hdr sshdr);
	272	void sd_print_result(const struct scsi_disk sdkp, const char msg, int result);
	273
e73aec82	274	#endif /* _SCSI_DISK_H */