xref: /freebsd/share/examples/scsi_target/scsi_cmds.c (revision c4b3637b44a66204547d7c6fef5641815df4527e)
1c38b150aSNate Lawson /*
2c38b150aSNate Lawson  * SCSI Disk Emulator
3c38b150aSNate Lawson  *
4c38b150aSNate Lawson  * Copyright (c) 2002 Nate Lawson.
5c38b150aSNate Lawson  * All rights reserved.
6c38b150aSNate Lawson  *
7c38b150aSNate Lawson  * Redistribution and use in source and binary forms, with or without
8c38b150aSNate Lawson  * modification, are permitted provided that the following conditions
9c38b150aSNate Lawson  * are met:
10c38b150aSNate Lawson  * 1. Redistributions of source code must retain the above copyright
11c38b150aSNate Lawson  *    notice, this list of conditions, and the following disclaimer,
12c38b150aSNate Lawson  *    without modification, immediately at the beginning of the file.
13c38b150aSNate Lawson  * 2. The name of the author may not be used to endorse or promote products
14c38b150aSNate Lawson  *    derived from this software without specific prior written permission.
15c38b150aSNate Lawson  *
16c38b150aSNate Lawson  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17c38b150aSNate Lawson  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18c38b150aSNate Lawson  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19c38b150aSNate Lawson  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20c38b150aSNate Lawson  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21c38b150aSNate Lawson  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22c38b150aSNate Lawson  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23c38b150aSNate Lawson  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24c38b150aSNate Lawson  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25c38b150aSNate Lawson  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26c38b150aSNate Lawson  * SUCH DAMAGE.
27c38b150aSNate Lawson  *
28c38b150aSNate Lawson  * $FreeBSD$
29c38b150aSNate Lawson  */
30c38b150aSNate Lawson 
31c38b150aSNate Lawson #include <stdio.h>
32c38b150aSNate Lawson #include <stddef.h>
33c38b150aSNate Lawson #include <stdarg.h>
34c38b150aSNate Lawson #include <stdlib.h>
35c38b150aSNate Lawson #include <string.h>
36c38b150aSNate Lawson #include <err.h>
37c38b150aSNate Lawson #include <aio.h>
38c38b150aSNate Lawson #include <assert.h>
39c38b150aSNate Lawson #include <sys/types.h>
40c38b150aSNate Lawson 
41c38b150aSNate Lawson #include <cam/cam.h>
42c38b150aSNate Lawson #include <cam/cam_ccb.h>
43c38b150aSNate Lawson #include <cam/scsi/scsi_all.h>
44c38b150aSNate Lawson #include <cam/scsi/scsi_targetio.h>
45c38b150aSNate Lawson #include "scsi_target.h"
46c38b150aSNate Lawson 
47c38b150aSNate Lawson typedef int targ_start_func(struct ccb_accept_tio *, struct ccb_scsiio *);
48c38b150aSNate Lawson typedef void targ_done_func(struct ccb_accept_tio *, struct ccb_scsiio *,
49c38b150aSNate Lawson 			      io_ops);
50c38b150aSNate Lawson 
51c38b150aSNate Lawson struct targ_cdb_handlers {
52c38b150aSNate Lawson 	u_int8_t	  cmd;
53c38b150aSNate Lawson 	targ_start_func  *start;
54c38b150aSNate Lawson 	targ_done_func	 *done;
55c38b150aSNate Lawson #define ILLEGAL_CDB	  0xFF
56c38b150aSNate Lawson };
57c38b150aSNate Lawson 
58c38b150aSNate Lawson static targ_start_func		tcmd_inquiry;
59c38b150aSNate Lawson static targ_start_func		tcmd_req_sense;
60c38b150aSNate Lawson static targ_start_func		tcmd_rd_cap;
61c38b150aSNate Lawson static targ_start_func		tcmd_rdwr;
62c38b150aSNate Lawson static targ_start_func		tcmd_rdwr_decode;
63c38b150aSNate Lawson static targ_done_func		tcmd_rdwr_done;
64c38b150aSNate Lawson static targ_start_func		tcmd_null_ok;
65c38b150aSNate Lawson static targ_start_func		tcmd_illegal_req;
66c38b150aSNate Lawson static int			start_io(struct ccb_accept_tio *atio,
67c38b150aSNate Lawson 					 struct ccb_scsiio *ctio, int dir);
68c38b150aSNate Lawson static int init_inquiry(u_int16_t req_flags, u_int16_t sim_flags);
69c38b150aSNate Lawson static struct initiator_state *
70c38b150aSNate Lawson 			tcmd_get_istate(u_int init_id);
71c38b150aSNate Lawson static void cdb_debug(u_int8_t *cdb, const char *msg, ...);
72c38b150aSNate Lawson 
73c38b150aSNate Lawson static struct targ_cdb_handlers cdb_handlers[] = {
74c38b150aSNate Lawson 	{ READ_10,		tcmd_rdwr,		tcmd_rdwr_done },
75c38b150aSNate Lawson 	{ WRITE_10,		tcmd_rdwr,		tcmd_rdwr_done },
76c38b150aSNate Lawson 	{ READ_6,		tcmd_rdwr,		tcmd_rdwr_done },
77c38b150aSNate Lawson 	{ WRITE_6,		tcmd_rdwr,		tcmd_rdwr_done },
78c38b150aSNate Lawson 	{ INQUIRY,		tcmd_inquiry,		NULL },
79c38b150aSNate Lawson 	{ REQUEST_SENSE,	tcmd_req_sense,		NULL },
80c38b150aSNate Lawson 	{ READ_CAPACITY,	tcmd_rd_cap,		NULL },
81c38b150aSNate Lawson 	{ TEST_UNIT_READY,	tcmd_null_ok,		NULL },
82c38b150aSNate Lawson 	{ START_STOP_UNIT,	tcmd_null_ok,		NULL },
83c38b150aSNate Lawson 	{ SYNCHRONIZE_CACHE,	tcmd_null_ok,		NULL },
84c38b150aSNate Lawson 	{ MODE_SENSE_6,		tcmd_illegal_req,	NULL },
85c38b150aSNate Lawson 	{ MODE_SELECT_6,	tcmd_illegal_req,	NULL },
86c38b150aSNate Lawson 	{ ILLEGAL_CDB,		NULL,			NULL }
87c38b150aSNate Lawson };
88c38b150aSNate Lawson 
89c38b150aSNate Lawson static struct scsi_inquiry_data inq_data;
90c38b150aSNate Lawson static struct initiator_state istates[MAX_INITIATORS];
91c38b150aSNate Lawson extern int		debug;
92c38b150aSNate Lawson extern u_int32_t	volume_size;
93c38b150aSNate Lawson extern size_t		sector_size;
94c38b150aSNate Lawson extern size_t		buf_size;
95c38b150aSNate Lawson 
96c38b150aSNate Lawson cam_status
97c38b150aSNate Lawson tcmd_init(u_int16_t req_inq_flags, u_int16_t sim_inq_flags)
98c38b150aSNate Lawson {
99c38b150aSNate Lawson 	struct initiator_state *istate;
100c38b150aSNate Lawson 	int i, ret;
101c38b150aSNate Lawson 
102c38b150aSNate Lawson 	/* Initialize our inquiry data */
103c38b150aSNate Lawson 	ret = init_inquiry(req_inq_flags, sim_inq_flags);
104c38b150aSNate Lawson 	if (ret != 0)
105c38b150aSNate Lawson         	return (ret);
106c38b150aSNate Lawson 
107c38b150aSNate Lawson 	/* We start out life with a UA to indicate power-on/reset. */
108c38b150aSNate Lawson 	for (i = 0; i < MAX_INITIATORS; i++) {
109c38b150aSNate Lawson 		istate = tcmd_get_istate(i);
110c38b150aSNate Lawson 		bzero(istate, sizeof(*istate));
111c38b150aSNate Lawson 		istate->pending_ua = UA_POWER_ON;
112c38b150aSNate Lawson 	}
113c38b150aSNate Lawson 
114c38b150aSNate Lawson 	return (0);
115c38b150aSNate Lawson }
116c38b150aSNate Lawson 
117c38b150aSNate Lawson /* Caller allocates CTIO, sets its init_id
118c38b150aSNate Lawson return 0 if done, 1 if more processing needed
119c38b150aSNate Lawson on 0, caller sets SEND_STATUS */
120c38b150aSNate Lawson int
121c38b150aSNate Lawson tcmd_handle(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio, io_ops event)
122c38b150aSNate Lawson {
123c38b150aSNate Lawson 	static struct targ_cdb_handlers *last_cmd;
124c38b150aSNate Lawson 	struct initiator_state *istate;
125c38b150aSNate Lawson 	struct atio_descr *a_descr;
126c38b150aSNate Lawson 	int ret;
127c38b150aSNate Lawson 
128031bacf8SNate Lawson 	if (debug) {
129c38b150aSNate Lawson 		warnx("tcmd_handle atio %p ctio %p atioflags %#x", atio, ctio,
130c38b150aSNate Lawson 		      atio->ccb_h.flags);
131031bacf8SNate Lawson 	}
132c38b150aSNate Lawson 	ret = 0;
133c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
134c38b150aSNate Lawson 
135c38b150aSNate Lawson 	/* Do a full lookup if one-behind cache failed */
136c38b150aSNate Lawson 	if (last_cmd == NULL || last_cmd->cmd != a_descr->cdb[0]) {
137c38b150aSNate Lawson 		struct targ_cdb_handlers *h;
138c38b150aSNate Lawson 
139c38b150aSNate Lawson 		for (h = cdb_handlers; h->cmd != ILLEGAL_CDB; h++) {
140c38b150aSNate Lawson 			if (a_descr->cdb[0] == h->cmd)
141c38b150aSNate Lawson 				break;
142c38b150aSNate Lawson 		}
143c38b150aSNate Lawson 		last_cmd = h;
144c38b150aSNate Lawson 	}
145c38b150aSNate Lawson 	if (last_cmd->cmd == ILLEGAL_CDB) {
146c38b150aSNate Lawson 		if (event != ATIO_WORK) {
147c38b150aSNate Lawson 			warnx("no done func for %#x???", a_descr->cdb[0]);
148c38b150aSNate Lawson 			abort();
149c38b150aSNate Lawson 		}
150c38b150aSNate Lawson 		/* Not found, return illegal request */
151c38b150aSNate Lawson 		warnx("cdb %#x not handled", a_descr->cdb[0]);
152c38b150aSNate Lawson 		tcmd_illegal_req(atio, ctio);
153c38b150aSNate Lawson 		send_ccb((union ccb *)ctio, /*priority*/1);
154c38b150aSNate Lawson 		return (0);
155c38b150aSNate Lawson 	}
156c38b150aSNate Lawson 
157c38b150aSNate Lawson 	/* call completion and exit */
158c38b150aSNate Lawson 	if (event != ATIO_WORK) {
159c38b150aSNate Lawson 		if (last_cmd->done != NULL)
160c38b150aSNate Lawson 			last_cmd->done(atio, ctio, event);
161c38b150aSNate Lawson 		else
162c38b150aSNate Lawson 			free_ccb((union ccb *)ctio);
163c38b150aSNate Lawson 		return (1);
164c38b150aSNate Lawson 	}
165c38b150aSNate Lawson 
166c38b150aSNate Lawson 	istate = tcmd_get_istate(ctio->init_id);
167c38b150aSNate Lawson 	if (istate == NULL) {
168c38b150aSNate Lawson 		tcmd_illegal_req(atio, ctio);
169c38b150aSNate Lawson 		send_ccb((union ccb *)ctio, /*priority*/1);
170c38b150aSNate Lawson 		return (0);
171c38b150aSNate Lawson 	}
172c38b150aSNate Lawson 
173c38b150aSNate Lawson 	if (istate->pending_ca == 0 && istate->pending_ua != 0 &&
174c38b150aSNate Lawson 	    a_descr->cdb[0] != INQUIRY) {
175c38b150aSNate Lawson 		tcmd_sense(ctio->init_id, ctio, SSD_KEY_UNIT_ATTENTION,
176c38b150aSNate Lawson 			   0x29, istate->pending_ua == UA_POWER_ON ? 1 : 2);
177c38b150aSNate Lawson 		istate->pending_ca = CA_UNIT_ATTN;
178c38b150aSNate Lawson 		if (debug) {
179c38b150aSNate Lawson 			cdb_debug(a_descr->cdb, "UA active for %u: ",
180c38b150aSNate Lawson 				  atio->init_id);
181c38b150aSNate Lawson 		}
182c38b150aSNate Lawson 		send_ccb((union ccb *)ctio, /*priority*/1);
183c38b150aSNate Lawson 		return (0);
184c38b150aSNate Lawson 	}
185c38b150aSNate Lawson 
186c38b150aSNate Lawson 	/* Store current CA and UA for later */
187c38b150aSNate Lawson 	istate->orig_ua = istate->pending_ua;
188c38b150aSNate Lawson 	istate->orig_ca = istate->pending_ca;
189c38b150aSNate Lawson 
190c38b150aSNate Lawson 	/*
191c38b150aSNate Lawson 	 * As per SAM2, any command that occurs
192c38b150aSNate Lawson 	 * after a CA is reported, clears the CA.  We must
193c38b150aSNate Lawson 	 * also clear the UA condition, if any, that caused
194c38b150aSNate Lawson 	 * the CA to occur assuming the UA is not for a
195c38b150aSNate Lawson 	 * persistent condition.
196c38b150aSNate Lawson 	 */
197c38b150aSNate Lawson 	istate->pending_ca = CA_NONE;
198c38b150aSNate Lawson 	if (istate->orig_ca == CA_UNIT_ATTN)
199c38b150aSNate Lawson 		istate->pending_ua = UA_NONE;
200c38b150aSNate Lawson 
201c38b150aSNate Lawson 	/* If we have a valid handler, call start or completion function */
202c38b150aSNate Lawson 	if (last_cmd->cmd != ILLEGAL_CDB) {
203c38b150aSNate Lawson 		ret = last_cmd->start(atio, ctio);
204c38b150aSNate Lawson 		/* XXX hack */
205c38b150aSNate Lawson 		if (last_cmd->start != tcmd_rdwr) {
206c38b150aSNate Lawson 			a_descr->init_req += ctio->dxfer_len;
207c38b150aSNate Lawson 			send_ccb((union ccb *)ctio, /*priority*/1);
208c38b150aSNate Lawson 		}
209c38b150aSNate Lawson 	}
210c38b150aSNate Lawson 
211c38b150aSNate Lawson 	return (ret);
212c38b150aSNate Lawson }
213c38b150aSNate Lawson 
214c38b150aSNate Lawson static struct initiator_state *
215c38b150aSNate Lawson tcmd_get_istate(u_int init_id)
216c38b150aSNate Lawson {
217c38b150aSNate Lawson 	if (init_id >= MAX_INITIATORS) {
218c38b150aSNate Lawson 		warnx("illegal init_id %d, max %d", init_id, MAX_INITIATORS - 1);
219c38b150aSNate Lawson 		return (NULL);
220c38b150aSNate Lawson 	} else {
221c38b150aSNate Lawson 		return (&istates[init_id]);
222c38b150aSNate Lawson 	}
223c38b150aSNate Lawson }
224c38b150aSNate Lawson 
225c38b150aSNate Lawson void
226c38b150aSNate Lawson tcmd_sense(u_int init_id, struct ccb_scsiio *ctio, u_int8_t flags,
227c38b150aSNate Lawson 	       u_int8_t asc, u_int8_t ascq)
228c38b150aSNate Lawson {
229c38b150aSNate Lawson 	struct initiator_state *istate;
230c38b150aSNate Lawson 	struct scsi_sense_data *sense;
231c38b150aSNate Lawson 
232c38b150aSNate Lawson 	/* Set our initiator's istate */
233c38b150aSNate Lawson 	istate = tcmd_get_istate(init_id);
234c38b150aSNate Lawson 	if (istate == NULL)
235c38b150aSNate Lawson 		return;
236c38b150aSNate Lawson 	istate->pending_ca |= CA_CMD_SENSE; /* XXX set instead of or? */
237c38b150aSNate Lawson 	sense = &istate->sense_data;
238c38b150aSNate Lawson 	bzero(sense, sizeof(*sense));
239c38b150aSNate Lawson 	sense->error_code = SSD_CURRENT_ERROR;
240c38b150aSNate Lawson 	sense->flags = flags;
241c38b150aSNate Lawson 	sense->add_sense_code = asc;
242c38b150aSNate Lawson 	sense->add_sense_code_qual = ascq;
243c38b150aSNate Lawson 	sense->extra_len =
244c38b150aSNate Lawson 		offsetof(struct scsi_sense_data, sense_key_spec[2]) -
245c38b150aSNate Lawson 		offsetof(struct scsi_sense_data, extra_len);
246c38b150aSNate Lawson 
247c38b150aSNate Lawson 	/* Fill out the supplied CTIO */
248c38b150aSNate Lawson 	if (ctio != NULL) {
249c38b150aSNate Lawson 		bcopy(sense, &ctio->sense_data, sizeof(*sense));
250c4b3637bSHidetoshi Shimokawa 		ctio->sense_len = sizeof(*sense);  /* XXX */
251c38b150aSNate Lawson 		ctio->ccb_h.flags &= ~CAM_DIR_MASK;
252c38b150aSNate Lawson 		ctio->ccb_h.flags |= CAM_DIR_NONE | /* CAM_SEND_SENSE | */
253c38b150aSNate Lawson 				     CAM_SEND_STATUS;
254c38b150aSNate Lawson 		ctio->dxfer_len = 0;
255c38b150aSNate Lawson 		ctio->scsi_status = SCSI_STATUS_CHECK_COND;
256c38b150aSNate Lawson 	}
257c38b150aSNate Lawson }
258c38b150aSNate Lawson 
259c38b150aSNate Lawson void
260c38b150aSNate Lawson tcmd_ua(u_int init_id, ua_types new_ua)
261c38b150aSNate Lawson {
262c38b150aSNate Lawson 	struct initiator_state *istate;
263c38b150aSNate Lawson 	u_int start, end;
264c38b150aSNate Lawson 
265c38b150aSNate Lawson 	if (init_id == CAM_TARGET_WILDCARD) {
266c38b150aSNate Lawson 		start = 0;
267c38b150aSNate Lawson 		end = MAX_INITIATORS - 1;
268c38b150aSNate Lawson 	} else {
269c38b150aSNate Lawson 		start = end = init_id;
270c38b150aSNate Lawson 	}
271c38b150aSNate Lawson 
272c38b150aSNate Lawson 	for (; start <= end; start++) {
273c38b150aSNate Lawson 		istate = tcmd_get_istate(start);
274c38b150aSNate Lawson 		if (istate == NULL)
275c38b150aSNate Lawson 			break;
276c38b150aSNate Lawson 		istate->pending_ua = new_ua;
277c38b150aSNate Lawson 	}
278c38b150aSNate Lawson }
279c38b150aSNate Lawson 
280c38b150aSNate Lawson static int
281c38b150aSNate Lawson tcmd_inquiry(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
282c38b150aSNate Lawson {
283c38b150aSNate Lawson 	struct scsi_inquiry *inq;
284c38b150aSNate Lawson 	struct atio_descr *a_descr;
285c38b150aSNate Lawson 	struct initiator_state *istate;
286c38b150aSNate Lawson 	struct scsi_sense_data *sense;
287c38b150aSNate Lawson 
288c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
289c38b150aSNate Lawson 	inq = (struct scsi_inquiry *)a_descr->cdb;
290c38b150aSNate Lawson 
291c38b150aSNate Lawson 	if (debug)
292c38b150aSNate Lawson 		cdb_debug(a_descr->cdb, "INQUIRY from %u: ", atio->init_id);
293c38b150aSNate Lawson 	/*
294c38b150aSNate Lawson 	 * Validate the command.  We don't support any VPD pages, so
295c38b150aSNate Lawson 	 * complain if EVPD or CMDDT is set.
296c38b150aSNate Lawson 	 */
297c38b150aSNate Lawson 	istate = tcmd_get_istate(ctio->init_id);
298c38b150aSNate Lawson 	sense = &istate->sense_data;
299c38b150aSNate Lawson 	if ((inq->byte2 & SI_EVPD) != 0) {
300c38b150aSNate Lawson 		tcmd_illegal_req(atio, ctio);
301c38b150aSNate Lawson 		sense->sense_key_spec[0] = SSD_SCS_VALID | SSD_FIELDPTR_CMD |
302c38b150aSNate Lawson 			SSD_BITPTR_VALID | /*bit value*/1;
303c38b150aSNate Lawson 		sense->sense_key_spec[1] = 0;
304c38b150aSNate Lawson 		sense->sense_key_spec[2] =
305c38b150aSNate Lawson 			offsetof(struct scsi_inquiry, byte2);
306c38b150aSNate Lawson 	} else if (inq->page_code != 0) {
307c38b150aSNate Lawson 		tcmd_illegal_req(atio, ctio);
308c38b150aSNate Lawson 		sense->sense_key_spec[0] = SSD_SCS_VALID | SSD_FIELDPTR_CMD;
309c38b150aSNate Lawson 		sense->sense_key_spec[1] = 0;
310c38b150aSNate Lawson 		sense->sense_key_spec[2] =
311c38b150aSNate Lawson 			offsetof(struct scsi_inquiry, page_code);
312c38b150aSNate Lawson 	} else {
313c38b150aSNate Lawson 		bcopy(&inq_data, ctio->data_ptr, sizeof(inq_data));
314c38b150aSNate Lawson 		ctio->dxfer_len = inq_data.additional_length + 4;
315c38b150aSNate Lawson 		ctio->dxfer_len = min(ctio->dxfer_len,
316c38b150aSNate Lawson 				      SCSI_CDB6_LEN(inq->length));
317c38b150aSNate Lawson 		ctio->ccb_h.flags |= CAM_DIR_IN | CAM_SEND_STATUS;
318c38b150aSNate Lawson 		ctio->scsi_status = SCSI_STATUS_OK;
319c38b150aSNate Lawson 	}
320c38b150aSNate Lawson 	return (0);
321c38b150aSNate Lawson }
322c38b150aSNate Lawson 
323c38b150aSNate Lawson /* Initialize the inquiry response structure with the requested flags */
324c38b150aSNate Lawson static int
325c38b150aSNate Lawson init_inquiry(u_int16_t req_flags, u_int16_t sim_flags)
326c38b150aSNate Lawson {
327c38b150aSNate Lawson 	struct scsi_inquiry_data *inq;
328c38b150aSNate Lawson 
329c38b150aSNate Lawson 	inq = &inq_data;
330c38b150aSNate Lawson 	bzero(inq, sizeof(*inq));
331c38b150aSNate Lawson 	inq->device = T_DIRECT | (SID_QUAL_LU_CONNECTED << 5);
332c4b3637bSHidetoshi Shimokawa #ifdef SCSI_REV_SPC
333c38b150aSNate Lawson 	inq->version = SCSI_REV_SPC; /* was 2 */
334c4b3637bSHidetoshi Shimokawa #else
335c4b3637bSHidetoshi Shimokawa 	inq->version = SCSI_REV_3; /* was 2 */
336c4b3637bSHidetoshi Shimokawa #endif
337c38b150aSNate Lawson 
338c38b150aSNate Lawson 	/*
339c38b150aSNate Lawson 	 * XXX cpi.hba_inquiry doesn't support Addr16 so we give the
340c38b150aSNate Lawson 	 * user what they want if they ask for it.
341c38b150aSNate Lawson 	 */
342c38b150aSNate Lawson 	if ((req_flags & SID_Addr16) != 0) {
343c38b150aSNate Lawson 		sim_flags |= SID_Addr16;
344c38b150aSNate Lawson 		warnx("Not sure SIM supports Addr16 but enabling it anyway");
345c38b150aSNate Lawson 	}
346c38b150aSNate Lawson 
347c38b150aSNate Lawson 	/* Advertise only what the SIM can actually support */
348c38b150aSNate Lawson 	req_flags &= sim_flags;
349c38b150aSNate Lawson 	scsi_ulto2b(req_flags, &inq->reserved[1]);
350c38b150aSNate Lawson 
351c38b150aSNate Lawson 	inq->response_format = 2; /* SCSI2 Inquiry Format */
352c38b150aSNate Lawson 	inq->additional_length = SHORT_INQUIRY_LENGTH -
353c38b150aSNate Lawson 		offsetof(struct scsi_inquiry_data, additional_length);
354c38b150aSNate Lawson 	bcopy("FreeBSD ", inq->vendor, SID_VENDOR_SIZE);
355c38b150aSNate Lawson 	bcopy("Emulated Disk   ", inq->product, SID_PRODUCT_SIZE);
356c38b150aSNate Lawson 	bcopy("0.1 ", inq->revision, SID_REVISION_SIZE);
357c38b150aSNate Lawson 	return (0);
358c38b150aSNate Lawson }
359c38b150aSNate Lawson 
360c38b150aSNate Lawson static int
361c38b150aSNate Lawson tcmd_req_sense(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
362c38b150aSNate Lawson {
363c38b150aSNate Lawson 	struct scsi_request_sense *rsense;
364c38b150aSNate Lawson 	struct scsi_sense_data *sense;
365c38b150aSNate Lawson 	struct initiator_state *istate;
366c38b150aSNate Lawson 	size_t dlen;
367c38b150aSNate Lawson 	struct atio_descr *a_descr;
368c38b150aSNate Lawson 
369c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
370c38b150aSNate Lawson 	rsense = (struct scsi_request_sense *)a_descr->cdb;
371c38b150aSNate Lawson 
372c38b150aSNate Lawson 	istate = tcmd_get_istate(ctio->init_id);
373c38b150aSNate Lawson 	sense = &istate->sense_data;
374c38b150aSNate Lawson 
375c38b150aSNate Lawson 	if (debug) {
376c38b150aSNate Lawson 		cdb_debug(a_descr->cdb, "REQ SENSE from %u: ", atio->init_id);
377c38b150aSNate Lawson 		warnx("Sending sense: %#x %#x %#x", sense->flags,
378c38b150aSNate Lawson 		      sense->add_sense_code, sense->add_sense_code_qual);
379c38b150aSNate Lawson 	}
380c38b150aSNate Lawson 
381c38b150aSNate Lawson 	if (istate->orig_ca == 0) {
382c38b150aSNate Lawson 		tcmd_sense(ctio->init_id, NULL, SSD_KEY_NO_SENSE, 0, 0);
383c38b150aSNate Lawson 		warnx("REQUEST SENSE from %u but no pending CA!",
384c38b150aSNate Lawson 		      ctio->init_id);
385c38b150aSNate Lawson 	}
386c38b150aSNate Lawson 
387c38b150aSNate Lawson 	bcopy(sense, ctio->data_ptr, sizeof(struct scsi_sense_data));
388c38b150aSNate Lawson 	dlen = offsetof(struct scsi_sense_data, extra_len) +
389c38b150aSNate Lawson 			sense->extra_len + 1;
390c38b150aSNate Lawson 	ctio->dxfer_len = min(dlen, SCSI_CDB6_LEN(rsense->length));
391c38b150aSNate Lawson 	ctio->ccb_h.flags |= CAM_DIR_IN | CAM_SEND_STATUS;
392c38b150aSNate Lawson 	ctio->scsi_status = SCSI_STATUS_OK;
393c38b150aSNate Lawson 	return (0);
394c38b150aSNate Lawson }
395c38b150aSNate Lawson 
396c38b150aSNate Lawson static int
397c38b150aSNate Lawson tcmd_rd_cap(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
398c38b150aSNate Lawson {
399c38b150aSNate Lawson 	struct scsi_read_capacity_data *srp;
400c38b150aSNate Lawson 	struct atio_descr *a_descr;
401c38b150aSNate Lawson 
402c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
403c38b150aSNate Lawson 	srp = (struct scsi_read_capacity_data *)ctio->data_ptr;
404c38b150aSNate Lawson 
405c38b150aSNate Lawson 	if (debug) {
406c38b150aSNate Lawson 		cdb_debug(a_descr->cdb, "READ CAP from %u (%u, %u): ",
407c38b150aSNate Lawson 			  atio->init_id, volume_size - 1, sector_size);
408c38b150aSNate Lawson 	}
409c38b150aSNate Lawson 
410c38b150aSNate Lawson 	bzero(srp, sizeof(*srp));
411c38b150aSNate Lawson 	scsi_ulto4b(volume_size - 1, srp->addr);
412c38b150aSNate Lawson 	scsi_ulto4b(sector_size, srp->length);
413c38b150aSNate Lawson 
414c38b150aSNate Lawson 	ctio->dxfer_len = sizeof(*srp);
415c38b150aSNate Lawson 	ctio->ccb_h.flags |= CAM_DIR_IN | CAM_SEND_STATUS;
416c38b150aSNate Lawson 	ctio->scsi_status = SCSI_STATUS_OK;
417c38b150aSNate Lawson 	return (0);
418c38b150aSNate Lawson }
419c38b150aSNate Lawson 
420c38b150aSNate Lawson static int
421c38b150aSNate Lawson tcmd_rdwr(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
422c38b150aSNate Lawson {
423c38b150aSNate Lawson 	struct atio_descr *a_descr;
424c38b150aSNate Lawson 	struct ctio_descr *c_descr;
425c38b150aSNate Lawson 	int ret;
426c38b150aSNate Lawson 
427c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
428c38b150aSNate Lawson 	c_descr = (struct ctio_descr *)ctio->ccb_h.targ_descr;
429c38b150aSNate Lawson 
430c38b150aSNate Lawson 	/* Command needs to be decoded */
431c38b150aSNate Lawson 	if ((a_descr->flags & CAM_DIR_MASK) == CAM_DIR_RESV) {
432c38b150aSNate Lawson 		if (debug)
433c38b150aSNate Lawson 			warnx("Calling rdwr_decode");
434c38b150aSNate Lawson 		ret = tcmd_rdwr_decode(atio, ctio);
435c38b150aSNate Lawson 		if (ret == 0) {
436c38b150aSNate Lawson 			send_ccb((union ccb *)ctio, /*priority*/1);
437c38b150aSNate Lawson 			return (0);
438c38b150aSNate Lawson 		}
439c38b150aSNate Lawson 	}
440c38b150aSNate Lawson 	ctio->ccb_h.flags |= a_descr->flags;
441c38b150aSNate Lawson 
442c38b150aSNate Lawson 	/* Call appropriate work function */
443c38b150aSNate Lawson 	if ((a_descr->flags & CAM_DIR_IN) != 0) {
444c38b150aSNate Lawson 		ret = start_io(atio, ctio, CAM_DIR_IN);
445c38b150aSNate Lawson 		if (debug)
446c38b150aSNate Lawson 			warnx("Starting DIR_IN @%lld:%u", c_descr->offset,
447c38b150aSNate Lawson 			      a_descr->targ_req);
448c38b150aSNate Lawson 	} else {
449c38b150aSNate Lawson 		ret = start_io(atio, ctio, CAM_DIR_OUT);
450c38b150aSNate Lawson 		if (debug)
451c38b150aSNate Lawson 			warnx("Starting DIR_OUT @%lld:%u", c_descr->offset,
452c38b150aSNate Lawson 			      a_descr->init_req);
453c38b150aSNate Lawson 	}
454c38b150aSNate Lawson 
455c38b150aSNate Lawson 	return (ret);
456c38b150aSNate Lawson }
457c38b150aSNate Lawson 
458c38b150aSNate Lawson static int
459c38b150aSNate Lawson tcmd_rdwr_decode(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
460c38b150aSNate Lawson {
461c38b150aSNate Lawson 	u_int32_t blkno, count;
462c38b150aSNate Lawson 	struct atio_descr *a_descr;
463c38b150aSNate Lawson 	u_int8_t *cdb;
464c38b150aSNate Lawson 
465c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
466c38b150aSNate Lawson 	cdb = a_descr->cdb;
467c38b150aSNate Lawson 	if (debug)
468c38b150aSNate Lawson 		cdb_debug(cdb, "R/W from %u: ", atio->init_id);
469c38b150aSNate Lawson 
470c38b150aSNate Lawson 	if (cdb[0] == READ_6 || cdb[0] == WRITE_6) {
471c38b150aSNate Lawson 		struct scsi_rw_6 *rw_6 = (struct scsi_rw_6 *)cdb;
472c38b150aSNate Lawson 		blkno = scsi_3btoul(rw_6->addr);
473c38b150aSNate Lawson 		count = rw_6->length;
474c38b150aSNate Lawson 	} else {
475c38b150aSNate Lawson 		struct scsi_rw_10 *rw_10 = (struct scsi_rw_10 *)cdb;
476c38b150aSNate Lawson 		blkno = scsi_4btoul(rw_10->addr);
477c38b150aSNate Lawson 		count = scsi_2btoul(rw_10->length);
478c38b150aSNate Lawson 	}
479c38b150aSNate Lawson 	if (blkno + count > volume_size) {
480c38b150aSNate Lawson 		warnx("Attempt to access past end of volume");
481c38b150aSNate Lawson 		tcmd_sense(ctio->init_id, ctio,
482c38b150aSNate Lawson 			   SSD_KEY_ILLEGAL_REQUEST, 0x21, 0);
483c38b150aSNate Lawson 		return (0);
484c38b150aSNate Lawson 	}
485c38b150aSNate Lawson 
486c38b150aSNate Lawson 	/* Get an (overall) data length and set direction */
487c38b150aSNate Lawson 	a_descr->base_off = ((off_t)blkno) * sector_size;
488c38b150aSNate Lawson 	a_descr->total_len = count * sector_size;
489c38b150aSNate Lawson 	if (a_descr->total_len == 0) {
490c38b150aSNate Lawson 		if (debug)
491c38b150aSNate Lawson 			warnx("r/w 0 blocks @ blkno %u", blkno);
492c38b150aSNate Lawson 		tcmd_null_ok(atio, ctio);
493c38b150aSNate Lawson 		return (0);
494c38b150aSNate Lawson 	} else if (cdb[0] == WRITE_6 || cdb[0] == WRITE_10) {
495c38b150aSNate Lawson 		a_descr->flags |= CAM_DIR_OUT;
496c38b150aSNate Lawson 		if (debug)
497c38b150aSNate Lawson 			warnx("write %u blocks @ blkno %u", count, blkno);
498c38b150aSNate Lawson 	} else {
499c38b150aSNate Lawson 		a_descr->flags |= CAM_DIR_IN;
500c38b150aSNate Lawson 		if (debug)
501c38b150aSNate Lawson 			warnx("read %u blocks @ blkno %u", count, blkno);
502c38b150aSNate Lawson 	}
503c38b150aSNate Lawson 	return (1);
504c38b150aSNate Lawson }
505c38b150aSNate Lawson 
506c38b150aSNate Lawson static int
507c38b150aSNate Lawson start_io(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio, int dir)
508c38b150aSNate Lawson {
509c38b150aSNate Lawson 	struct atio_descr *a_descr;
510c38b150aSNate Lawson 	struct ctio_descr *c_descr;
511c38b150aSNate Lawson 	int ret;
512c38b150aSNate Lawson 
513c38b150aSNate Lawson 	/* Set up common structures */
514c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
515c38b150aSNate Lawson 	c_descr = (struct ctio_descr *)ctio->ccb_h.targ_descr;
516c38b150aSNate Lawson 
517c38b150aSNate Lawson 	if (dir == CAM_DIR_IN) {
518c38b150aSNate Lawson 		c_descr->offset = a_descr->base_off + a_descr->targ_req;
519c38b150aSNate Lawson 		ctio->dxfer_len = a_descr->total_len - a_descr->targ_req;
520c38b150aSNate Lawson 	} else {
521c38b150aSNate Lawson 		c_descr->offset = a_descr->base_off + a_descr->init_req;
522c38b150aSNate Lawson 		ctio->dxfer_len = a_descr->total_len - a_descr->init_req;
523c38b150aSNate Lawson 	}
524c38b150aSNate Lawson 	ctio->dxfer_len = min(ctio->dxfer_len, buf_size);
525c38b150aSNate Lawson 	assert(ctio->dxfer_len >= 0);
526c38b150aSNate Lawson 
527c38b150aSNate Lawson 	c_descr->aiocb.aio_offset = c_descr->offset;
528c38b150aSNate Lawson 	c_descr->aiocb.aio_nbytes = ctio->dxfer_len;
529c38b150aSNate Lawson 
530c38b150aSNate Lawson 	/* If DIR_IN, start read from target, otherwise begin CTIO xfer. */
531c38b150aSNate Lawson 	ret = 1;
532c38b150aSNate Lawson 	if (dir == CAM_DIR_IN) {
533c38b150aSNate Lawson 		if (aio_read(&c_descr->aiocb) < 0)
534c38b150aSNate Lawson 			err(1, "aio_read"); /* XXX */
535c38b150aSNate Lawson 		a_descr->targ_req += ctio->dxfer_len;
536c38b150aSNate Lawson 		if (a_descr->targ_req == a_descr->total_len) {
537c38b150aSNate Lawson 			ctio->ccb_h.flags |= CAM_SEND_STATUS;
538c38b150aSNate Lawson 			ctio->scsi_status = SCSI_STATUS_OK;
539c38b150aSNate Lawson 			ret = 0;
540c38b150aSNate Lawson 		}
541c38b150aSNate Lawson 	} else {
542c38b150aSNate Lawson 		if (a_descr->targ_ack == a_descr->total_len)
543c38b150aSNate Lawson 			tcmd_null_ok(atio, ctio);
544c38b150aSNate Lawson 		a_descr->init_req += ctio->dxfer_len;
545c38b150aSNate Lawson 		if (a_descr->init_req == a_descr->total_len &&
546c38b150aSNate Lawson 		    ctio->dxfer_len > 0) {
547c38b150aSNate Lawson 			/*
548c38b150aSNate Lawson 			 * If data phase done, remove atio from workq.
549c38b150aSNate Lawson 			 * The completion handler will call work_atio to
550c38b150aSNate Lawson 			 * send the final status.
551c38b150aSNate Lawson 			 */
552c38b150aSNate Lawson 			ret = 0;
553c38b150aSNate Lawson 		}
554c38b150aSNate Lawson 		send_ccb((union ccb *)ctio, /*priority*/1);
555c38b150aSNate Lawson 	}
556c38b150aSNate Lawson 
557c38b150aSNate Lawson 	return (ret);
558c38b150aSNate Lawson }
559c38b150aSNate Lawson 
560c38b150aSNate Lawson static void
561c38b150aSNate Lawson tcmd_rdwr_done(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio,
562c38b150aSNate Lawson 	       io_ops event)
563c38b150aSNate Lawson {
564c38b150aSNate Lawson 	struct atio_descr *a_descr;
565c38b150aSNate Lawson 	struct ctio_descr *c_descr;
566c38b150aSNate Lawson 
567c38b150aSNate Lawson 	a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
568c38b150aSNate Lawson 	c_descr = (struct ctio_descr *)ctio->ccb_h.targ_descr;
569c38b150aSNate Lawson 
570c38b150aSNate Lawson 	switch (event) {
571c38b150aSNate Lawson 	case AIO_DONE:
572c38b150aSNate Lawson 		if (aio_return(&c_descr->aiocb) < 0) {
573c38b150aSNate Lawson 			warn("aio_return error");
574c38b150aSNate Lawson 			/* XXX */
575c38b150aSNate Lawson 			tcmd_sense(ctio->init_id, ctio,
576c38b150aSNate Lawson 				   SSD_KEY_MEDIUM_ERROR, 0, 0);
577c38b150aSNate Lawson 			send_ccb((union ccb *)ctio, /*priority*/1);
578c38b150aSNate Lawson 			break;
579c38b150aSNate Lawson 		}
580c38b150aSNate Lawson 		a_descr->targ_ack += ctio->dxfer_len;
581c38b150aSNate Lawson 		if ((a_descr->flags & CAM_DIR_IN) != 0) {
582c38b150aSNate Lawson 			if (debug)
583c38b150aSNate Lawson 				warnx("sending CTIO for AIO read");
584c38b150aSNate Lawson 			a_descr->init_req += ctio->dxfer_len;
585c38b150aSNate Lawson 			send_ccb((union ccb *)ctio, /*priority*/1);
586c38b150aSNate Lawson 		} else {
587c38b150aSNate Lawson 			/* Use work function to send final status */
588c38b150aSNate Lawson 			if (a_descr->init_req == a_descr->total_len)
589c38b150aSNate Lawson 				work_atio(atio);
590c38b150aSNate Lawson 			if (debug)
591c38b150aSNate Lawson 				warnx("AIO done freeing CTIO");
592c38b150aSNate Lawson 			free_ccb((union ccb *)ctio);
593c38b150aSNate Lawson 		}
594c38b150aSNate Lawson 		break;
595c38b150aSNate Lawson 	case CTIO_DONE:
596c38b150aSNate Lawson 		if (ctio->ccb_h.status != CAM_REQ_CMP) {
597c38b150aSNate Lawson 			/* XXX */
598c38b150aSNate Lawson 			errx(1, "CTIO failed, status %#x", ctio->ccb_h.status);
599c38b150aSNate Lawson 		}
600c38b150aSNate Lawson 		a_descr->init_ack += ctio->dxfer_len;
601c38b150aSNate Lawson 		if ((a_descr->flags & CAM_DIR_MASK) == CAM_DIR_OUT &&
602c38b150aSNate Lawson 		    ctio->dxfer_len > 0) {
603c38b150aSNate Lawson 			if (debug)
604c38b150aSNate Lawson 				warnx("sending AIO for CTIO write");
605c38b150aSNate Lawson 			a_descr->targ_req += ctio->dxfer_len;
606c38b150aSNate Lawson 			if (aio_write(&c_descr->aiocb) < 0)
607c38b150aSNate Lawson 				err(1, "aio_write"); /* XXX */
608c38b150aSNate Lawson 		} else {
609c38b150aSNate Lawson 			if (debug)
610c38b150aSNate Lawson 				warnx("CTIO done freeing CTIO");
611c38b150aSNate Lawson 			free_ccb((union ccb *)ctio);
612c38b150aSNate Lawson 		}
613c38b150aSNate Lawson 		break;
614c38b150aSNate Lawson 	default:
615c38b150aSNate Lawson 		warnx("Unknown completion code %d", event);
616c38b150aSNate Lawson 		abort();
617c38b150aSNate Lawson 		/* NOTREACHED */
618c38b150aSNate Lawson 	}
619c38b150aSNate Lawson }
620c38b150aSNate Lawson 
621c38b150aSNate Lawson /* Simple ok message used by TUR, SYNC_CACHE, etc. */
622c38b150aSNate Lawson static int
623c38b150aSNate Lawson tcmd_null_ok(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
624c38b150aSNate Lawson {
625c38b150aSNate Lawson 	if (debug) {
626c38b150aSNate Lawson 		struct atio_descr *a_descr;
627c38b150aSNate Lawson 
628c38b150aSNate Lawson 		a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
629c38b150aSNate Lawson 		cdb_debug(a_descr->cdb, "Sending null ok to %u : ", atio->init_id);
630c38b150aSNate Lawson 	}
631c38b150aSNate Lawson 
632c38b150aSNate Lawson 	ctio->dxfer_len = 0;
633c38b150aSNate Lawson 	ctio->ccb_h.flags &= ~CAM_DIR_MASK;
634c38b150aSNate Lawson 	ctio->ccb_h.flags |= CAM_DIR_NONE | CAM_SEND_STATUS;
635c38b150aSNate Lawson 	ctio->scsi_status = SCSI_STATUS_OK;
636c38b150aSNate Lawson 	return (0);
637c38b150aSNate Lawson }
638c38b150aSNate Lawson 
639c38b150aSNate Lawson /* Simple illegal request message used by MODE SENSE, etc. */
640c38b150aSNate Lawson static int
641c38b150aSNate Lawson tcmd_illegal_req(struct ccb_accept_tio *atio, struct ccb_scsiio *ctio)
642c38b150aSNate Lawson {
643c38b150aSNate Lawson 	if (debug) {
644c38b150aSNate Lawson 		struct atio_descr *a_descr;
645c38b150aSNate Lawson 
646c38b150aSNate Lawson 		a_descr = (struct atio_descr *)atio->ccb_h.targ_descr;
647c38b150aSNate Lawson 		cdb_debug(a_descr->cdb, "Sending ill req to %u: ", atio->init_id);
648c38b150aSNate Lawson 	}
649c38b150aSNate Lawson 
650c38b150aSNate Lawson 	tcmd_sense(atio->init_id, ctio, SSD_KEY_ILLEGAL_REQUEST,
651c38b150aSNate Lawson 		   /*asc*/0x24, /*ascq*/0);
652c38b150aSNate Lawson 	return (0);
653c38b150aSNate Lawson }
654c38b150aSNate Lawson 
655c38b150aSNate Lawson static void
656c38b150aSNate Lawson cdb_debug(u_int8_t *cdb, const char *msg, ...)
657c38b150aSNate Lawson {
658c38b150aSNate Lawson 	char msg_buf[512];
659c38b150aSNate Lawson 	int len;
660c38b150aSNate Lawson 	va_list ap;
661c38b150aSNate Lawson 
662c38b150aSNate Lawson 	va_start(ap, msg);
663c38b150aSNate Lawson 	vsnprintf(msg_buf, sizeof(msg_buf), msg, ap);
664c38b150aSNate Lawson 	va_end(ap);
665c38b150aSNate Lawson 	len = strlen(msg_buf);
666c38b150aSNate Lawson 	scsi_cdb_string(cdb, msg_buf + len, sizeof(msg_buf) - len);
667c38b150aSNate Lawson 	warnx("%s", msg_buf);
668c38b150aSNate Lawson }
669