blob: 1e1421b06565ca750b4326683f78a0e8ae276a1e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _SCSI_SCSI_EH_H
2#define _SCSI_SCSI_EH_H
3
James Bottomley645a0c62007-10-15 21:07:17 -04004#include <linux/scatterlist.h>
5
Boaz Harroshe1c23462007-10-08 16:36:45 +02006#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007struct scsi_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07008struct 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 */
19struct 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
Hannes Reinecke4753cbc2014-10-24 14:26:52 +020030static inline bool scsi_sense_valid(const struct scsi_sense_hdr *sshdr)
James Bottomley33aa6872005-08-28 11:31:14 -050031{
32 if (!sshdr)
Hannes Reinecke4753cbc2014-10-24 14:26:52 +020033 return false;
James Bottomley33aa6872005-08-28 11:31:14 -050034
35 return (sshdr->response_code & 0x70) == 0x70;
36}
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Tejun Heo041c5fc2006-01-23 13:09:36 +090039extern void scsi_eh_finish_cmd(struct scsi_cmnd *scmd,
40 struct list_head *done_q);
41extern void scsi_eh_flush_done_q(struct list_head *done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042extern void scsi_report_bus_reset(struct Scsi_Host *, int);
43extern void scsi_report_device_reset(struct Scsi_Host *, int, int);
44extern int scsi_block_when_processing_errors(struct scsi_device *);
Hannes Reinecke4753cbc2014-10-24 14:26:52 +020045extern bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
46 struct scsi_sense_hdr *sshdr);
47extern bool scsi_command_normalize_sense(const struct scsi_cmnd *cmd,
48 struct scsi_sense_hdr *sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Hannes Reinecke4753cbc2014-10-24 14:26:52 +020050static inline bool scsi_sense_is_deferred(const struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070051{
52 return ((sshdr->response_code >= 0x70) && (sshdr->response_code & 1));
53}
54
55extern const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
56 int desc_type);
57
58extern int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
59 u64 * info_out);
FUJITA Tomonori3bc6a262008-03-25 09:26:49 +090060
61extern void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq);
62
Christoph Hellwig176aa9d2014-10-11 12:06:47 +020063extern int scsi_ioctl_reset(struct scsi_device *, int __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Boaz Harroshe1c23462007-10-08 16:36:45 +020065struct scsi_eh_save {
Boaz Harrosh30b0c372007-12-13 13:47:40 +020066 /* saved state */
Boaz Harroshe1c23462007-10-08 16:36:45 +020067 int result;
68 enum dma_data_direction data_direction;
Alan Stern12265702008-07-21 10:25:52 -040069 unsigned underflow;
Boaz Harroshe1c23462007-10-08 16:36:45 +020070 unsigned char cmd_len;
Martin K. Petersendb007fc2008-07-17 04:28:31 -040071 unsigned char prot_op;
Boaz Harrosh64a87b22008-04-30 11:19:47 +030072 unsigned char *cmnd;
Boaz Harrosh30b0c372007-12-13 13:47:40 +020073 struct scsi_data_buffer sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020074 struct request *next_rq;
Boaz Harrosh30b0c372007-12-13 13:47:40 +020075 /* new command support */
Boaz Harrosh64a87b22008-04-30 11:19:47 +030076 unsigned char eh_cmnd[BLK_MAX_CDB];
Boaz Harroshe1c23462007-10-08 16:36:45 +020077 struct scatterlist sense_sgl;
78};
79
80extern 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
84extern void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd,
85 struct scsi_eh_save *ses);
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#endif /* _SCSI_SCSI_EH_H */