projects/linux·blob master · refs

228 lines · 5.9 KiB

1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * This header file contains public constants and structures used by
4 * the SCSI initiator code.
5 */
6#ifndef _SCSI_SCSI_H
7#define _SCSI_SCSI_H
8
9#include <linux/types.h>
10
11#include <asm/param.h>
12
13#include <scsi/scsi_common.h>
14#include <scsi/scsi_proto.h>
15#include <scsi/scsi_status.h>
16
17struct scsi_cmnd;
18
19enum scsi_timeouts {
20 SCSI_DEFAULT_EH_TIMEOUT = 10 * HZ,
21};
22
23/*
24 * DIX-capable adapters effectively support infinite chaining for the
25 * protection information scatterlist
26 */
27#define SCSI_MAX_PROT_SG_SEGMENTS 0xFFFF
28
29/*
30 * Special value for scanning to specify scanning or rescanning of all
31 * possible channels, (target) ids, or luns on a given shost.
32 */
33#define SCAN_WILD_CARD ~0
34
35/*
36 * standard mode-select header prepended to all mode-select commands
37 */
38
39struct ccs_modesel_head {
40 __u8 _r1; /* reserved */
41 __u8 medium; /* device-specific medium type */
42 __u8 _r2; /* reserved */
43 __u8 block_desc_length; /* block descriptor length */
44 __u8 density; /* device-specific density code */
45 __u8 number_blocks_hi; /* number of blocks in this block desc */
46 __u8 number_blocks_med;
47 __u8 number_blocks_lo;
48 __u8 _r3;
49 __u8 block_length_hi; /* block length for blocks in this desc */
50 __u8 block_length_med;
51 __u8 block_length_lo;
52};
53
54/*
55 * The Well Known LUNS (SAM-3) in our int representation of a LUN
56 */
57#define SCSI_W_LUN_BASE 0xc100
58#define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1)
59#define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2)
60#define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3)
61
62static inline int scsi_is_wlun(u64 lun)
63{
64 return (lun & 0xff00) == SCSI_W_LUN_BASE;
65}
66
67/**
68 * scsi_status_is_check_condition - check the status return.
69 *
70 * @status: the status passed up from the driver (including host and
71 * driver components)
72 *
73 * Returns: %true if the status code is SAM_STAT_CHECK_CONDITION.
74 */
75static inline int scsi_status_is_check_condition(int status)
76{
77 if (status < 0)
78 return false;
79 status &= 0xfe;
80 return status == SAM_STAT_CHECK_CONDITION;
81}
82
83/*
84 * Extended message codes.
85 */
86#define EXTENDED_MODIFY_DATA_POINTER 0x00
87#define EXTENDED_SDTR 0x01
88#define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
89#define EXTENDED_WDTR 0x03
90#define EXTENDED_PPR 0x04
91#define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
92
93/*
94 * Internal return values.
95 */
96enum scsi_disposition {
97 NEEDS_RETRY = 0x2001,
98 SUCCESS = 0x2002,
99 FAILED = 0x2003,
100 QUEUED = 0x2004,
101 SOFT_ERROR = 0x2005,
102 ADD_TO_MLQUEUE = 0x2006,
103 TIMEOUT_ERROR = 0x2007,
104 SCSI_RETURN_NOT_HANDLED = 0x2008,
105 FAST_IO_FAIL = 0x2009,
106};
107
108/*
109 * Status values returned by the .queuecommand() callback if a command has not
110 * been queued.
111 */
112enum scsi_qc_status {
113 SCSI_MLQUEUE_HOST_BUSY = 0x1055,
114 SCSI_MLQUEUE_DEVICE_BUSY = 0x1056,
115 SCSI_MLQUEUE_EH_RETRY = 0x1057,
116 SCSI_MLQUEUE_TARGET_BUSY = 0x1058,
117};
118
119/*
120 * Use these to separate status msg and our bytes
121 *
122 * These are set by:
123 *
124 * status byte = set from target device
125 * msg_byte (unused)
126 * host_byte = set by low-level driver to indicate status.
127 */
128#define status_byte(result) (result & 0xff)
129#define host_byte(result) (((result) >> 16) & 0xff)
130
131#define sense_class(sense) (((sense) >> 4) & 0x7)
132#define sense_error(sense) ((sense) & 0xf)
133#define sense_valid(sense) ((sense) & 0x80)
134
135/*
136 * default timeouts
137*/
138#define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
139#define START_STOP_TIMEOUT (60 * HZ)
140#define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
141#define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
142#define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
143
144
145#define IDENTIFY_BASE 0x80
146#define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
147 ((can_disconnect) ? 0x40 : 0) |\
148 ((lun) & 0x07))
149
150/*
151 * struct scsi_device::scsi_level values. For SCSI devices other than those
152 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
153 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
154 * variable is visible to the user via sysfs.
155 */
156
157#define SCSI_UNKNOWN 0
158#define SCSI_1 1
159#define SCSI_1_CCS 2
160#define SCSI_2 3
161#define SCSI_3 4 /* SPC */
162#define SCSI_SPC_2 5
163#define SCSI_SPC_3 6
164#define SCSI_SPC_4 7
165#define SCSI_SPC_5 8
166#define SCSI_SPC_6 14
167
168/*
169 * INQ PERIPHERAL QUALIFIERS
170 */
171#define SCSI_INQ_PQ_CON 0x00
172#define SCSI_INQ_PQ_NOT_CON 0x01
173#define SCSI_INQ_PQ_NOT_CAP 0x03
174
175
176/*
177 * Here are some scsi specific ioctl commands which are sometimes useful.
178 *
179 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
180 */
181
182/* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
183#define SCSI_IOCTL_GET_IDLUN 0x5382
184
185/* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
186
187/* Used to obtain the host number of a device. */
188#define SCSI_IOCTL_PROBE_HOST 0x5385
189
190/* Used to obtain the bus number for a device */
191#define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
192
193/* Used to obtain the PCI location of a device */
194#define SCSI_IOCTL_GET_PCI 0x5387
195
196/**
197 * scsi_status_is_good - check the status return.
198 *
199 * @status: the status passed up from the driver (including host and
200 * driver components)
201 *
202 * Returns: %true for known good conditions that may be treated as
203 * command completed normally
204 */
205static inline bool scsi_status_is_good(int status)
206{
207 if (status < 0)
208 return false;
209
210 if (host_byte(status) == DID_NO_CONNECT)
211 return false;
212
213 /*
214 * FIXME: bit0 is listed as reserved in SCSI-2, but is
215 * significant in SCSI-3. For now, we follow the SCSI-2
216 * behaviour and ignore reserved bits.
217 */
218 status &= 0xfe;
219 return ((status == SAM_STAT_GOOD) ||
220 (status == SAM_STAT_CONDITION_MET) ||
221 /* Next two "intermediate" statuses are obsolete in SAM-4 */
222 (status == SAM_STAT_INTERMEDIATE) ||
223 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) ||
224 /* FIXME: this is obsolete in SAM-3 */
225 (status == SAM_STAT_COMMAND_TERMINATED));
226}
227
228#endif /* _SCSI_SCSI_H */