[linux-2.6-block.git] / include / scsi / scsi_eh.h

#ifndef _SCSI_SCSI_EH_H
#define _SCSI_SCSI_EH_H

#include <linux/scatterlist.h>

#include <scsi/scsi_cmnd.h>
struct scsi_device;
struct Scsi_Host;

/*
 * This is a slightly modified SCSI sense "descriptor" format header.
 * The addition is to allow the 0x70 and 0x71 response codes. The idea
 * is to place the salient data from either "fixed" or "descriptor" sense
 * format into one structure to ease application processing.
 *
 * The original sense buffer should be kept around for those cases
 * in which more information is required (e.g. the LBA of a MEDIUM ERROR).
 */
struct scsi_sense_hdr {		/* See SPC-3 section 4.5 */
	u8 response_code;	/* permit: 0x0, 0x70, 0x71, 0x72, 0x73 */
	u8 sense_key;
	u8 asc;
	u8 ascq;
	u8 byte4;
	u8 byte5;
	u8 byte6;
	u8 additional_length;	/* always 0 for fixed sense format */
};

static inline bool scsi_sense_valid(const struct scsi_sense_hdr *sshdr)
{
	if (!sshdr)
		return false;

	return (sshdr->response_code & 0x70) == 0x70;
}


extern void scsi_eh_finish_cmd(struct scsi_cmnd *scmd,
			       struct list_head *done_q);
extern void scsi_eh_flush_done_q(struct list_head *done_q);
extern void scsi_report_bus_reset(struct Scsi_Host *, int);
extern void scsi_report_device_reset(struct Scsi_Host *, int, int);
extern int scsi_block_when_processing_errors(struct scsi_device *);
extern bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
				 struct scsi_sense_hdr *sshdr);
extern bool scsi_command_normalize_sense(const struct scsi_cmnd *cmd,
					 struct scsi_sense_hdr *sshdr);

static inline bool scsi_sense_is_deferred(const struct scsi_sense_hdr *sshdr)
{
	return ((sshdr->response_code >= 0x70) && (sshdr->response_code & 1));
}

extern const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
				       int desc_type);

extern int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
				   u64 * info_out);

extern void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq);

extern int scsi_ioctl_reset(struct scsi_device *, int __user *);

struct scsi_eh_save {
	/* saved state */
	int result;
	enum dma_data_direction data_direction;
	unsigned underflow;
	unsigned char cmd_len;
	unsigned char prot_op;
	unsigned char *cmnd;
	struct scsi_data_buffer sdb;
	struct request *next_rq;
	/* new command support */
	unsigned char eh_cmnd[BLK_MAX_CDB];
	struct scatterlist sense_sgl;
};

extern void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd,
		struct scsi_eh_save *ses, unsigned char *cmnd,
		int cmnd_size, unsigned sense_bytes);

extern void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd,
		struct scsi_eh_save *ses);

#endif /* _SCSI_SCSI_EH_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _SCSI_SCSI_EH_H
	2	#define _SCSI_SCSI_EH_H
	3
645a0c6c JB	4	#include <linux/scatterlist.h>
645a0c6c JB	5
e1c23468	6	#include <scsi/scsi_cmnd.h>
1da177e4	7	struct scsi_device;
1da177e4 LT	8	struct Scsi_Host;
	9
	10	/*
	11	* This is a slightly modified SCSI sense "descriptor" format header.
	12	* The addition is to allow the 0x70 and 0x71 response codes. The idea
	13	* is to place the salient data from either "fixed" or "descriptor" sense
	14	* format into one structure to ease application processing.
	15	*
	16	* The original sense buffer should be kept around for those cases
	17	* in which more information is required (e.g. the LBA of a MEDIUM ERROR).
	18	*/
	19	struct scsi_sense_hdr { /* See SPC-3 section 4.5 */
	20	u8 response_code; /* permit: 0x0, 0x70, 0x71, 0x72, 0x73 */
	21	u8 sense_key;
	22	u8 asc;
	23	u8 ascq;
	24	u8 byte4;
	25	u8 byte5;
	26	u8 byte6;
	27	u8 additional_length; /* always 0 for fixed sense format */
	28	};
	29
4753cbc0	30	static inline bool scsi_sense_valid(const struct scsi_sense_hdr *sshdr)
33aa687d JB	31	{
33aa687d JB	32	if (!sshdr)
4753cbc0	33	return false;
33aa687d JB	34
	35	return (sshdr->response_code & 0x70) == 0x70;
	36	}
	37
1da177e4	38
041c5fc3 TH	39	extern void scsi_eh_finish_cmd(struct scsi_cmnd *scmd,
	40	struct list_head *done_q);
	41	extern void scsi_eh_flush_done_q(struct list_head *done_q);
1da177e4 LT	42	extern void scsi_report_bus_reset(struct Scsi_Host *, int);
	43	extern void scsi_report_device_reset(struct Scsi_Host *, int, int);
	44	extern int scsi_block_when_processing_errors(struct scsi_device *);
4753cbc0 HR	45	extern bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
	46	struct scsi_sense_hdr *sshdr);
	47	extern bool scsi_command_normalize_sense(const struct scsi_cmnd *cmd,
	48	struct scsi_sense_hdr *sshdr);
1da177e4	49
4753cbc0	50	static inline bool scsi_sense_is_deferred(const struct scsi_sense_hdr *sshdr)
1da177e4 LT	51	{
	52	return ((sshdr->response_code >= 0x70) && (sshdr->response_code & 1));
	53	}
	54
	55	extern const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
	56	int desc_type);
	57
	58	extern int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
	59	u64 * info_out);
3bc6a261 FT	60
	61	extern void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq);
	62
176aa9d6	63	extern int scsi_ioctl_reset(struct scsi_device , int __user );
1da177e4	64
e1c23468	65	struct scsi_eh_save {
30b0c37b	66	/* saved state */
e1c23468 BH	67	int result;
e1c23468 BH	68	enum dma_data_direction data_direction;
12265709	69	unsigned underflow;
e1c23468	70	unsigned char cmd_len;
db007fc5	71	unsigned char prot_op;
64a87b24	72	unsigned char *cmnd;
30b0c37b	73	struct scsi_data_buffer sdb;
6f9a35e2	74	struct request *next_rq;
30b0c37b	75	/* new command support */
64a87b24	76	unsigned char eh_cmnd[BLK_MAX_CDB];
e1c23468 BH	77	struct scatterlist sense_sgl;
	78	};
	79
	80	extern void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd,
	81	struct scsi_eh_save ses, unsigned char cmnd,
	82	int cmnd_size, unsigned sense_bytes);
	83
	84	extern void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd,
	85	struct scsi_eh_save *ses);
	86
1da177e4	87	#endif /* _SCSI_SCSI_EH_H */