1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_SCSI_SCSI_PKT_H
#define _SYS_SCSI_SCSI_PKT_H
#include <sys/scsi/scsi_types.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifdef _KERNEL
/*
* SCSI packet definition.
*
* This structure defines the packet which is allocated by a library
* function and handed to a target driver. The target driver fills
* in some information, and passes it to the library for transport
* to an addressed SCSI device. The host adapter found by
* the library fills in some other information as the command is
* processed. When the command completes (or can be taken no further)
* the function specified in the packet is called with a pointer to
* the packet as it argument. From fields within the packet, the target
* driver can determine the success or failure of the command.
*/
struct scsi_pkt {
opaque_t pkt_ha_private; /* private data for host adapter */
struct scsi_address pkt_address; /* destination packet is for */
opaque_t pkt_private; /* private data for target driver */
void (*pkt_comp)(struct scsi_pkt *); /* completion routine */
uint_t pkt_flags; /* flags */
int pkt_time; /* time allotted to complete command */
uchar_t *pkt_scbp; /* pointer to status block */
uchar_t *pkt_cdbp; /* pointer to command block */
ssize_t pkt_resid; /* data bytes not transferred */
uint_t pkt_state; /* state of command */
uint_t pkt_statistics; /* statistics */
uchar_t pkt_reason; /* reason completion called */
/*
* The DDI does not allow a driver to allocate it's own scsi_pkt(9S),
* a driver should not have *any* compiled in dependencies on
* "sizeof (struct scsi_pkt)". If the driver has such dependencies, it
* limits SCSA's ability to evolve. The proper way for an HBA to
* allocate a scsi_pkt is via scsi_hba_pkt_alloc(9F), or the newer
* tran_setup_pkt(9E) interfaces. Allocation rules have been in place
* for many years, unfortunately a significant number of drivers
* are still broken.
*
* NB: Until we can trust drivers to follow DDI scsi_pkt(9S) allocation
* rules, access to all fields below require special consideration.
* Access to these fields is limited to code paths that 'know' correct
* scsi_pkt allocation interfaces must have been used. This means that
* any target driver access to these fields is suspect, since a target
* knows nothing about how an HBA drivers performs scsi_pkt allocation.
*
* NB: A private scsi_pkt_size() interface has been added to simplify
* 'fixing' legacy HBA drivers. Use of scsi_pkt_size() is only
* appropriate when the effort/cost of fixing a legacy driver to use
* proper DDI scsi_pkt allocation interfaces is too great given the
* remaining driver life. New HBA drivers should *not* use
* scsi_pkt_size().
*
* NB: While HBA drivers with violations are being fixed, in
* rare cases access conditioned by scsi_pkt_allocated_correctly() is
* permitted.
*/
/* HBA driver only, iff scsi_hba_pkt_alloc(9F)|tran_seup_pkt(9E) used */
uint_t pkt_cdblen; /* length of pkt_cdbp */
uint_t pkt_tgtlen; /* length of pkt_private */
uint_t pkt_scblen; /* lenght of pkt_scbp */
/* HBA driver only, iff tran_seup_pkt(9E) used */
ddi_dma_handle_t pkt_handle; /* private */
uint_t pkt_numcookies; /* number of DMA cookies */
off_t pkt_dma_offset; /* private */
size_t pkt_dma_len; /* private */
uint_t pkt_dma_flags; /* DMA flags */
ddi_dma_cookie_t *pkt_cookies; /* array of DMA cookies */
/* private: iff scsi_pkt_allocated_correctly() */
int pkt_path_instance; /* pHCI transport path */
/* stage-temporary: iff scsi_pkt_allocated_correctly() */
void *pkt_stmp; /* temporary for current pkt stage */
#ifdef SCSI_SIZE_CLEAN_VERIFY
/*
* Must be last: Building a driver with-and-without
* -DSCSI_SIZE_CLEAN_VERIFY, and checking driver modules for
* differences with a tools like 'wsdiff' allows a developer to verify
* that their driver has no dependencies on scsi*(9S) size.
*/
int i_pkt_pad[8];
#endif /* SCSI_SIZE_CLEAN_VERIFY */
};
#endif /* _KERNEL */
/*
* Definitions for the pkt_flags field.
*/
/*
* Following defines are generic.
*/
#define FLAG_STAG 0x4000 /* Run command with Simple attribute */
#define FLAG_OTAG 0x2000 /* Run command with Ordered attribute */
#define FLAG_HTAG 0x1000 /* Run command with Head of Queue attribute */
#define FLAG_TAGMASK (FLAG_HTAG|FLAG_OTAG|FLAG_STAG)
#define FLAG_ACA 0x0100 /* internal; do not use */
#define FLAG_HEAD 0x8000 /* This cmd should be put at the head */
/* of the HBA driver's queue */
#define FLAG_SENSING 0x0400 /* Running request sense for failed pkt */
#define FLAG_NOINTR 0x0001 /* Run command with no cmd completion */
/* callback; command has been completed */
/* upon return from scsi_transport(9F) */
/*
* Following defines are appropriate for SCSI parallel bus.
*/
#define FLAG_NODISCON 0x0002 /* Run command without disconnects */
#define FLAG_NOPARITY 0x0008 /* Run command without parity checking */
#define FLAG_RENEGOTIATE_WIDE_SYNC \
0x1000000 /* Do wide and sync renegotiation before */
/* transporting this command to target */
/*
* Following defines are internal i.e. not part of DDI.
*/
#define FLAG_IMMEDIATE_CB \
0x0800 /* Immediate callback on command */
/* completion, ie. do not defer */
/*
* Following defines are for USCSI options.
*/
#define FLAG_SILENT 0x00010000
#define FLAG_DIAGNOSE 0x00020000
#define FLAG_ISOLATE 0x00040000
/*
* pkg_flag for TLR
*/
#define FLAG_TLR 0x00080000
/*
* Following define is for scsi_vhci.
* NOQUEUE If pHCI cannot transport the command to the device,
* do not queue the pkt in pHCI. Return immediately with
* TRAN_BUSY.
* PATH_INSTANCE Select specific path (pkt_path_instance).
* We need both a pkt_path_instance field and flag bit so
* that a retry after a path failure, which sets
* pkt_path_instance to failed path, does not select the
* failed path.
*/
#define FLAG_NOQUEUE 0x80000000
#define FLAG_PKT_PATH_INSTANCE 0x40000000 /* Tell vhci the path to use */
#define FLAG_PKT_COMP_CALLED 0x20000000 /* Set once pkt_comp called */
/*
* Definitions for the pkt_reason field.
*/
/*
* Following defines are generic.
*/
#define CMD_CMPLT 0 /* no transport errors- normal completion */
#define CMD_INCOMPLETE 1 /* transport stopped with not normal state */
#define CMD_DMA_DERR 2 /* dma direction error occurred */
#define CMD_TRAN_ERR 3 /* unspecified transport error */
#define CMD_RESET 4 /* Target completed hard reset sequence */
#define CMD_ABORTED 5 /* Command transport aborted on request */
#define CMD_TIMEOUT 6 /* Command timed out */
#define CMD_DATA_OVR 7 /* Data Overrun */
#define CMD_CMD_OVR 8 /* Command Overrun */
#define CMD_STS_OVR 9 /* Status Overrun */
#define CMD_TERMINATED 22 /* Command transport terminated on request */
#define CMD_TLR_OFF 23 /* don't support TLR */
/*
* Following defines are appropriate for SCSI parallel bus.
*/
#define CMD_BADMSG 10 /* Message not Command Complete */
#define CMD_NOMSGOUT 11 /* Target refused to go to Message Out phase */
#define CMD_XID_FAIL 12 /* Extended Identify message rejected */
#define CMD_IDE_FAIL 13 /* Initiator Detected Error message rejected */
#define CMD_ABORT_FAIL 14 /* Abort message rejected */
#define CMD_REJECT_FAIL 15 /* Reject message rejected */
#define CMD_NOP_FAIL 16 /* No Operation message rejected */
#define CMD_PER_FAIL 17 /* Message Parity Error message rejected */
#define CMD_BDR_FAIL 18 /* Bus Device Reset message rejected */
#define CMD_ID_FAIL 19 /* Identify message rejected */
#define CMD_UNX_BUS_FREE 20 /* Unexpected Bus Free Phase occurred */
#define CMD_TAG_REJECT 21 /* Target rejected our tag message */
#define CMD_DEV_GONE 24 /* The device has been removed */
/* Used by scsi_rname(9F) */
#define CMD_REASON_ASCII { \
"cmplt", "incomplete", "dma_derr", "tran_err", "reset", \
"aborted", "timeout", "data_ovr", "cmd_ovr", "sts_ovr", \
"badmsg", "nomsgout", "xid_fail", "ide_fail", "abort_fail", \
"reject_fail", "nop_fail", "per_fail", "bdr_fail", "id_fail", \
"unexpected_bus_free", "tag reject", "terminated", "", "gone", \
NULL }
/*
* Definitions for the pkt_state field
*/
#define STATE_GOT_BUS 0x01 /* Success in getting SCSI bus */
#define STATE_GOT_TARGET 0x02 /* Successfully connected with target */
#define STATE_SENT_CMD 0x04 /* Command successfully sent */
#define STATE_XFERRED_DATA 0x08 /* Data transfer took place */
#define STATE_GOT_STATUS 0x10 /* SCSI status received */
#define STATE_ARQ_DONE 0x20 /* auto rqsense took place */
#define STATE_XARQ_DONE 0X40 /* extra auto rqsense took place */
/*
* Definitions for the pkt_statistics field
*/
/*
* Following defines are generic.
*/
#define STAT_BUS_RESET 0x8 /* Reset operation on interconnect */
#define STAT_DEV_RESET 0x10 /* Target completed hard reset sequence */
#define STAT_ABORTED 0x20 /* Command was aborted */
#define STAT_TERMINATED 0x80 /* Command was terminated */
#define STAT_TIMEOUT 0x40 /* Command experienced a timeout */
/*
* Following defines are appropriate for SCSI parallel bus.
*/
#define STAT_DISCON 0x1 /* Command experienced a disconnect */
#define STAT_SYNC 0x2 /* Command did a synchronous data transfer */
#define STAT_PERR 0x4 /* Command experienced a SCSI parity error */
/*
* Definitions for what scsi_transport returns
*/
#define TRAN_ACCEPT 1
#define TRAN_BUSY 0
#define TRAN_BADPKT -1
#define TRAN_FATAL_ERROR -2 /* HBA cannot accept any pkts */
#ifdef _KERNEL
/*
* Kernel function declarations
*/
int scsi_transport(struct scsi_pkt *pkt);
#define pkt_transport scsi_transport
#define SCSI_POLL_TIMEOUT 60
#endif /* _KERNEL */
#ifdef __cplusplus
}
#endif
#endif /* _SYS_SCSI_SCSI_PKT_H */
|
