[linux-block.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 zoned_disk_info - Specific properties of a ZBC SCSI device.
 * @nr_zones: number of zones.
 * @zone_blocks: number of logical blocks per zone.
 *
 * This data structure holds the ZBC SCSI device properties that are retrieved
 * twice: a first time before the gendisk capacity is known and a second time
 * after the gendisk capacity is known.
 */
struct zoned_disk_info {
	u32		nr_zones;
	u32		zone_blocks;
};

struct scsi_disk {
	struct scsi_device *device;

	/*
	 * disk_dev is used to show attributes in /sys/class/scsi_disk/,
	 * but otherwise not really needed.  Do not use for refcounting.
	 */
	struct device	disk_dev;
	struct gendisk	*disk;
	struct opal_dev *opal_dev;
#ifdef CONFIG_BLK_DEV_ZONED
	/* Updated during revalidation before the gendisk capacity is known. */
	struct zoned_disk_info	early_zone_info;
	/* Updated during revalidation after the gendisk capacity is known. */
	struct zoned_disk_info	zone_info;
	u32		zones_optimal_open;
	u32		zones_optimal_nonseq;
	u32		zones_max_open;
	/*
	 * Either zero or a power of two. If not zero it means that the offset
	 * between zone starting LBAs is constant.
	 */
	u32		zone_starting_lba_gran;
#endif
	atomic_t	openers;
	sector_t	capacity;	/* size in logical blocks */
	int		max_retries;
	u32		min_xfer_blocks;
	u32		max_xfer_blocks;
	u32		opt_xfer_blocks;
	u32		max_ws_blocks;
	u32		max_unmap_blocks;
	u32		unmap_granularity;
	u32		unmap_alignment;

	u32		max_atomic;
	u32		atomic_alignment;
	u32		atomic_granularity;
	u32		max_atomic_with_boundary;
	u32		max_atomic_boundary;

	u32		index;
	unsigned int	physical_block_size;
	unsigned int	max_medium_access_timeouts;
	unsigned int	medium_access_timed_out;
			/* number of permanent streams */
	u16		permanent_stream_count;
	u8		media_present;
	u8		write_prot;
	u8		protection_type;/* Data Integrity Field */
	u8		provisioning_mode;
	u8		zeroing_mode;
	u8		nr_actuators;		/* Number of actuators */
	bool		suspended;	/* Disk is suspended (stopped) */
	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;
	unsigned	rscs : 1; /* reduced stream control support */
	unsigned	use_atomic_write_boundary : 1;
};
#define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev)

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

#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);
}

void sd_dif_config_host(struct scsi_disk *sdkp, struct queue_limits *lim);

#ifdef CONFIG_BLK_DEV_ZONED

int sd_zbc_read_zones(struct scsi_disk *sdkp, struct queue_limits *lim,
		u8 buf[SD_BUF_SIZE]);
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);

#else /* CONFIG_BLK_DEV_ZONED */

static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
		struct queue_limits *lim, u8 buf[SD_BUF_SIZE])
{
	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;
}

#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
628617be BVA	70	/**
	71	* struct zoned_disk_info - Specific properties of a ZBC SCSI device.
	72	* @nr_zones: number of zones.
	73	* @zone_blocks: number of logical blocks per zone.
	74	*
	75	* This data structure holds the ZBC SCSI device properties that are retrieved
	76	* twice: a first time before the gendisk capacity is known and a second time
	77	* after the gendisk capacity is known.
	78	*/
	79	struct zoned_disk_info {
	80	u32 nr_zones;
	81	u32 zone_blocks;
	82	};
	83
e73aec82	84	struct scsi_disk {
e73aec82	85	struct scsi_device *device;
fad45c30 CH	86
	87	/*
	88	* disk_dev is used to show attributes in /sys/class/scsi_disk/,
	89	* but otherwise not really needed. Do not use for refcounting.
	90	*/
	91	struct device disk_dev;
e73aec82	92	struct gendisk *disk;
d80210f2	93	struct opal_dev *opal_dev;
89d94756	94	#ifdef CONFIG_BLK_DEV_ZONED
628617be BVA	95	/* Updated during revalidation before the gendisk capacity is known. */
	96	struct zoned_disk_info early_zone_info;
	97	/* Updated during revalidation after the gendisk capacity is known. */
	98	struct zoned_disk_info zone_info;
354f1132 BVA	99	u32 zones_optimal_open;
	100	u32 zones_optimal_nonseq;
	101	u32 zones_max_open;
c976e588 DLM	102	/*
	103	* Either zero or a power of two. If not zero it means that the offset
	104	* between zone starting LBAs is constant.
	105	*/
	106	u32 zone_starting_lba_gran;
89d94756	107	#endif
409f3499	108	atomic_t openers;
f08bb1e0	109	sector_t capacity; /* size in logical blocks */
0610959f	110	int max_retries;
631669a2	111	u32 min_xfer_blocks;
bcdb247c	112	u32 max_xfer_blocks;
ca369d51	113	u32 opt_xfer_blocks;
c98a0eb0 MP	114	u32 max_ws_blocks;
	115	u32 max_unmap_blocks;
	116	u32 unmap_granularity;
	117	u32 unmap_alignment;
bf4ae8f2 JG	118
	119	u32 max_atomic;
	120	u32 atomic_alignment;
	121	u32 atomic_granularity;
	122	u32 max_atomic_with_boundary;
	123	u32 max_atomic_boundary;
	124
e73aec82	125	u32 index;
526f7c79	126	unsigned int physical_block_size;
18a4d0a2 MP	127	unsigned int max_medium_access_timeouts;
18a4d0a2 MP	128	unsigned int medium_access_timed_out;
4f53138f BVA	129	/* number of permanent streams */
4f53138f BVA	130	u16 permanent_stream_count;
e73aec82 MP	131	u8 media_present;
e73aec82 MP	132	u8 write_prot;
e0597d70	133	u8 protection_type;/* Data Integrity Field */
c98a0eb0	134	u8 provisioning_mode;
e6bd9312	135	u8 zeroing_mode;
e815d365	136	u8 nr_actuators; /* Number of actuators */
99398d20	137	bool suspended; /* Disk is suspended (stopped) */
e0597d70	138	unsigned ATO : 1; /* state of disk ATO bit */
39c60a09	139	unsigned cache_override : 1; /* temp override of WCE,RCD */
e73aec82 MP	140	unsigned WCE : 1; /* state of disk WCE bit */
	141	unsigned RCD : 1; /* state of disk RCD bit, unused */
	142	unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
70a9b873	143	unsigned first_scan : 1;
c98a0eb0 MP	144	unsigned lbpme : 1;
	145	unsigned lbprz : 1;
	146	unsigned lbpu : 1;
	147	unsigned lbpws : 1;
	148	unsigned lbpws10 : 1;
	149	unsigned lbpvpd : 1;
66c28f97	150	unsigned ws10 : 1;
5db44863	151	unsigned ws16 : 1;
89d94756 HR	152	unsigned rc_basis: 2;
	153	unsigned zoned: 2;
	154	unsigned urswrz : 1;
d80210f2	155	unsigned security : 1;
7a38dc0b	156	unsigned ignore_medium_access_errors : 1;
4f53138f	157	unsigned rscs : 1; /* reduced stream control support */
bf4ae8f2	158	unsigned use_atomic_write_boundary : 1;
e73aec82	159	};
fad45c30	160	#define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev)
e73aec82	161
5b635da1 MP	162	static inline struct scsi_disk scsi_disk(struct gendisk disk)
5b635da1 MP	163	{
e7f76552	164	return disk->private_data;
5b635da1 MP	165	}
5b635da1 MP	166
e73aec82 MP	167	#define sd_printk(prefix, sdsk, fmt, a...) \
e73aec82 MP	168	(sdsk)->disk ? \
22e0d994 HR	169	sdev_prefix_printk(prefix, (sdsk)->device, \
	170	(sdsk)->disk->disk_name, fmt, ##a) : \
	171	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
e73aec82	172
b2bff6ce MP	173	#define sd_first_printk(prefix, sdsk, fmt, a...) \
b2bff6ce MP	174	do { \
df46cac3	175	if ((sdsk)->first_scan) \
b2bff6ce MP	176	sd_printk(prefix, sdsk, fmt, ##a); \
	177	} while (0)
	178
18a4d0a2 MP	179	static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
	180	{
	181	switch (scmd->cmnd[0]) {
	182	case READ_6:
	183	case READ_10:
	184	case READ_12:
	185	case READ_16:
	186	case SYNCHRONIZE_CACHE:
	187	case VERIFY:
	188	case VERIFY_12:
	189	case VERIFY_16:
	190	case WRITE_6:
	191	case WRITE_10:
	192	case WRITE_12:
	193	case WRITE_16:
	194	case WRITE_SAME:
	195	case WRITE_SAME_16:
	196	case UNMAP:
	197	return 1;
	198	case VARIABLE_LENGTH_CMD:
	199	switch (scmd->cmnd[9]) {
	200	case READ_32:
	201	case VERIFY_32:
	202	case WRITE_32:
	203	case WRITE_SAME_32:
	204	return 1;
	205	}
	206	}
	207
	208	return 0;
	209	}
	210
f08bb1e0 MP	211	static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
	212	{
	213	return blocks << (ilog2(sdev->sector_size) - 9);
	214	}
	215
6b7e9cde MP	216	static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
	217	{
	218	return blocks * sdev->sector_size;
	219	}
	220
6eadc612 DLM	221	static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
	222	{
	223	return bytes >> ilog2(sdev->sector_size);
	224	}
	225
89d94756 HR	226	static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
	227	{
	228	return sector >> (ilog2(sdev->sector_size) - 9);
	229	}
	230
c6e56cf6	231	void sd_dif_config_host(struct scsi_disk sdkp, struct queue_limits lim);
af55ff67	232
89d94756 HR	233	#ifdef CONFIG_BLK_DEV_ZONED
89d94756 HR	234
804e498e CH	235	int sd_zbc_read_zones(struct scsi_disk sdkp, struct queue_limits lim,
804e498e CH	236	u8 buf[SD_BUF_SIZE]);
a3d8a257	237	int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
ad512f20 AJ	238	blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
ad512f20 AJ	239	unsigned char op, bool all);
5795eb44 JT	240	unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
5795eb44 JT	241	struct scsi_sense_hdr *sshdr);
d4100351 CH	242	int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
d4100351 CH	243	unsigned int nr_zones, report_zones_cb cb, void *data);
89d94756 HR	244
	245	#else /* CONFIG_BLK_DEV_ZONED */
	246
804e498e CH	247	static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
804e498e CH	248	struct queue_limits *lim, u8 buf[SD_BUF_SIZE])
89d94756 HR	249	{
	250	return 0;
	251	}
	252
a3d8a257 DLM	253	static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
	254	{
	255	return 0;
	256	}
89d94756	257
ad512f20 AJ	258	static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
	259	unsigned char op,
	260	bool all)
89d94756	261	{
159b2cbf	262	return BLK_STS_TARGET;
89d94756 HR	263	}
89d94756 HR	264
5795eb44 JT	265	static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
	266	unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
	267	{
27ba3e8f	268	return good_bytes;
5795eb44 JT	269	}
5795eb44 JT	270
e76239a3 CH	271	#define sd_zbc_report_zones NULL
e76239a3 CH	272
89d94756 HR	273	#endif /* CONFIG_BLK_DEV_ZONED */
89d94756 HR	274
a35989a0 DLM	275	void sd_print_sense_hdr(struct scsi_disk sdkp, struct scsi_sense_hdr sshdr);
	276	void sd_print_result(const struct scsi_disk sdkp, const char msg, int result);
	277
e73aec82	278	#endif /* _SCSI_DISK_H */