xref: /netbsd-src/tests/dev/scsipi/libscsitest/scsitest.c (revision 05eb58f6e4b453523a4c018ada43bc6f434ec274)
1*05eb58f6Scjep /*	$NetBSD: scsitest.c,v 1.5 2021/08/07 22:05:26 cjep Exp $	*/
28fa17e47Spooka 
38fa17e47Spooka /*
48fa17e47Spooka  * Copyright (c) 2010 Antti Kantee.  All Rights Reserved.
58fa17e47Spooka  *
68fa17e47Spooka  * Redistribution and use in source and binary forms, with or without
78fa17e47Spooka  * modification, are permitted provided that the following conditions
88fa17e47Spooka  * are met:
98fa17e47Spooka  * 1. Redistributions of source code must retain the above copyright
108fa17e47Spooka  *    notice, this list of conditions and the following disclaimer.
118fa17e47Spooka  * 2. Redistributions in binary form must reproduce the above copyright
128fa17e47Spooka  *    notice, this list of conditions and the following disclaimer in the
138fa17e47Spooka  *    documentation and/or other materials provided with the distribution.
148fa17e47Spooka  *
158fa17e47Spooka  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
168fa17e47Spooka  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
178fa17e47Spooka  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
188fa17e47Spooka  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
198fa17e47Spooka  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
208fa17e47Spooka  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
218fa17e47Spooka  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
228fa17e47Spooka  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
238fa17e47Spooka  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
248fa17e47Spooka  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
258fa17e47Spooka  * SUCH DAMAGE.
268fa17e47Spooka  */
278fa17e47Spooka 
288fa17e47Spooka /*
298fa17e47Spooka  * A SCSI target which is useful for debugging our scsipi driver stack.
308fa17e47Spooka  * Currently it pretends to be a single CD.
318fa17e47Spooka  *
328fa17e47Spooka  * Freely add the necessary features for your tests.  Just remember to
338fa17e47Spooka  * run the atf test suite to make sure you didn't cause regressions to
348fa17e47Spooka  * other tests.
358fa17e47Spooka  */
368fa17e47Spooka 
378fa17e47Spooka #include <sys/cdefs.h>
38*05eb58f6Scjep __KERNEL_RCSID(0, "$NetBSD: scsitest.c,v 1.5 2021/08/07 22:05:26 cjep Exp $");
398fa17e47Spooka 
408fa17e47Spooka #include <sys/param.h>
418fa17e47Spooka #include <sys/atomic.h>
428fa17e47Spooka #include <sys/buf.h>
438fa17e47Spooka #include <sys/device.h>
448fa17e47Spooka #include <sys/malloc.h>
458fa17e47Spooka #include <sys/fcntl.h>
468fa17e47Spooka 
478fa17e47Spooka #include <dev/scsipi/scsiconf.h>
488fa17e47Spooka #include <dev/scsipi/scsipiconf.h>
498fa17e47Spooka #include <dev/scsipi/scsi_disk.h>
508fa17e47Spooka #include <dev/scsipi/scsipi_cd.h>
518fa17e47Spooka #include <dev/scsipi/scsipi_all.h>
528fa17e47Spooka 
538fa17e47Spooka #include <rump/rumpuser.h>
540159a35eSpooka 
550159a35eSpooka #include "scsitest.h"
568fa17e47Spooka 
578fa17e47Spooka int	scsitest_match(device_t, cfdata_t, void *);
588fa17e47Spooka void	scsitest_attach(device_t, device_t, void *);
598fa17e47Spooka 
608fa17e47Spooka struct scsitest {
618fa17e47Spooka 	struct scsipi_channel sc_channel;
628fa17e47Spooka 	struct scsipi_adapter sc_adapter;
638fa17e47Spooka };
648fa17e47Spooka 
658fa17e47Spooka CFATTACH_DECL_NEW(scsitest, sizeof(struct scsitest), scsitest_match,
668fa17e47Spooka 	scsitest_attach, NULL, NULL);
678fa17e47Spooka 
688fa17e47Spooka /*
698fa17e47Spooka  * tosi.iso can be used to deliver CD requests to a host file with the
708fa17e47Spooka  * name in USE_TOSI_ISO (yes, it's extrasimplistic).
718fa17e47Spooka  */
728fa17e47Spooka //#define USE_TOSI_ISO
738fa17e47Spooka 
748fa17e47Spooka #define CDBLOCKSIZE 2048
758fa17e47Spooka static uint32_t mycdsize = 2048;
768fa17e47Spooka static int isofd;
778fa17e47Spooka 
788fa17e47Spooka #define MYCDISO "tosi.iso"
798fa17e47Spooka 
808fa17e47Spooka unsigned rump_scsitest_err[RUMP_SCSITEST_MAXERROR];
818fa17e47Spooka 
828fa17e47Spooka static void
sense_notready(struct scsipi_xfer * xs)838fa17e47Spooka sense_notready(struct scsipi_xfer *xs)
848fa17e47Spooka {
858fa17e47Spooka 	struct scsi_sense_data *sense = &xs->sense.scsi_sense;
868fa17e47Spooka 
878fa17e47Spooka 	xs->error = XS_SENSE;
888fa17e47Spooka 
898fa17e47Spooka 	sense->response_code = 0x70;
908fa17e47Spooka 	sense->flags = SKEY_NOT_READY;
918fa17e47Spooka 	sense->asc = 0x3A;
928fa17e47Spooka 	sense->ascq = 0x00;
938fa17e47Spooka 	sense->extra_len = 6;
948fa17e47Spooka }
958fa17e47Spooka 
968fa17e47Spooka /*
978fa17e47Spooka  * This is pretty much a CD target for now
988fa17e47Spooka  */
998fa17e47Spooka static void
scsitest_request(struct scsipi_channel * chan,scsipi_adapter_req_t req,void * arg)1008fa17e47Spooka scsitest_request(struct scsipi_channel *chan,
1018fa17e47Spooka 	scsipi_adapter_req_t req, void *arg)
1028fa17e47Spooka {
1038fa17e47Spooka 	struct scsipi_xfer *xs = arg;
1048fa17e47Spooka 	struct scsipi_generic *cmd = xs->cmd;
1058fa17e47Spooka #ifdef USE_TOSI_ISO
1068fa17e47Spooka 	int error;
1078fa17e47Spooka #endif
1088fa17e47Spooka 
1098fa17e47Spooka 	if (req != ADAPTER_REQ_RUN_XFER)
1108fa17e47Spooka 		return;
1118fa17e47Spooka 
1128fa17e47Spooka 	//show_scsipi_xs(xs);
1138fa17e47Spooka 
1148fa17e47Spooka 	switch (cmd->opcode) {
1158fa17e47Spooka 	case SCSI_TEST_UNIT_READY:
1168fa17e47Spooka 		if (isofd == -1)
1178fa17e47Spooka 			sense_notready(xs);
1188fa17e47Spooka 
1198fa17e47Spooka 		break;
1208fa17e47Spooka 	case INQUIRY: {
1218fa17e47Spooka 		struct scsipi_inquiry_data *inqbuf = (void *)xs->data;
1228fa17e47Spooka 
1238fa17e47Spooka 		memset(inqbuf, 0, sizeof(*inqbuf));
1248fa17e47Spooka 		inqbuf->device = T_CDROM;
1258fa17e47Spooka 		inqbuf->dev_qual2 = SID_REMOVABLE;
1267081cfefSmrg 		strncpy(inqbuf->vendor, "RUMPHOBO", sizeof inqbuf->vendor);
1277081cfefSmrg 		strncpy(inqbuf->product, "It's a LIE", sizeof inqbuf->product);
1287081cfefSmrg 		strncpy(inqbuf->revision, "0.00", sizeof inqbuf->revision);
1298fa17e47Spooka 		break;
1308fa17e47Spooka 	}
1318fa17e47Spooka 	case READ_CD_CAPACITY: {
1328fa17e47Spooka 		struct scsipi_read_cd_cap_data *ret = (void *)xs->data;
1338fa17e47Spooka 
1348fa17e47Spooka 		_lto4b(CDBLOCKSIZE, ret->length);
1358fa17e47Spooka 		_lto4b(mycdsize, ret->addr);
1368fa17e47Spooka 
1378fa17e47Spooka 		break;
1388fa17e47Spooka 	}
1398fa17e47Spooka 	case READ_DISCINFO: {
1408fa17e47Spooka 		struct scsipi_read_discinfo_data *ret = (void *)xs->data;
1418fa17e47Spooka 
1428fa17e47Spooka 		memset(ret, 0, sizeof(*ret));
1438fa17e47Spooka 		break;
1448fa17e47Spooka 	}
1458fa17e47Spooka 	case READ_TRACKINFO: {
1468fa17e47Spooka 		struct scsipi_read_trackinfo_data *ret = (void *)xs->data;
1478fa17e47Spooka 
1488fa17e47Spooka 		_lto4b(mycdsize, ret->track_size);
1498fa17e47Spooka 		break;
1508fa17e47Spooka 	}
1518fa17e47Spooka 	case READ_TOC: {
1528fa17e47Spooka 		struct scsipi_toc_header *ret = (void *)xs->data;
1538fa17e47Spooka 
1548fa17e47Spooka 		memset(ret, 0, sizeof(*ret));
1558fa17e47Spooka 		break;
1568fa17e47Spooka 	}
1578fa17e47Spooka 	case START_STOP: {
1588fa17e47Spooka 		struct scsipi_start_stop *param = (void *)cmd;
1598fa17e47Spooka 
1608fa17e47Spooka 		if (param->how & SSS_LOEJ) {
1618fa17e47Spooka #ifdef USE_TOSI_ISO
1628fa17e47Spooka 			rumpuser_close(isofd, &error);
1638fa17e47Spooka #endif
1648fa17e47Spooka 			isofd = -1;
1658fa17e47Spooka 		}
1668fa17e47Spooka 		break;
1678fa17e47Spooka 	}
1688fa17e47Spooka 	case SCSI_SYNCHRONIZE_CACHE_10: {
1698fa17e47Spooka 		if (isofd == -1) {
1708fa17e47Spooka 			if ((xs->xs_control & XS_CTL_SILENT) == 0)
1718fa17e47Spooka 				atomic_inc_uint(&rump_scsitest_err
1728fa17e47Spooka 				    [RUMP_SCSITEST_NOISYSYNC]);
1738fa17e47Spooka 
1748fa17e47Spooka 			sense_notready(xs);
1758fa17e47Spooka 		}
1768fa17e47Spooka 
1778fa17e47Spooka 		break;
1788fa17e47Spooka 	}
1798fa17e47Spooka 	case GET_CONFIGURATION: {
1808fa17e47Spooka 		memset(xs->data, 0, sizeof(struct scsipi_get_conf_data));
1818fa17e47Spooka 		break;
1828fa17e47Spooka 	}
1838fa17e47Spooka 	case SCSI_READ_6_COMMAND: {
1848fa17e47Spooka #ifdef USE_TOSI_ISO
1858fa17e47Spooka 		struct scsi_rw_6 *param = (void *)cmd;
1868fa17e47Spooka 
1878fa17e47Spooka 		printf("reading %d bytes from %d\n",
1888fa17e47Spooka 		    param->length * CDBLOCKSIZE,
1898fa17e47Spooka 		    _3btol(param->addr) * CDBLOCKSIZE);
1908fa17e47Spooka 		rumpuser_pread(isofd, xs->data,
1918fa17e47Spooka 		     param->length * CDBLOCKSIZE,
1928fa17e47Spooka 		     _3btol(param->addr) * CDBLOCKSIZE,
1938fa17e47Spooka 		     &error);
1948fa17e47Spooka #endif
1958fa17e47Spooka 
1968fa17e47Spooka 		break;
1978fa17e47Spooka 	}
1988fa17e47Spooka 	case SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL:
1998fa17e47Spooka 		/* hardcoded for now */
2008fa17e47Spooka 		break;
2018fa17e47Spooka 	default:
2028fa17e47Spooka 		printf("unhandled opcode 0x%x\n", cmd->opcode);
2038fa17e47Spooka 		break;
2048fa17e47Spooka 	}
2058fa17e47Spooka 
2068fa17e47Spooka 	scsipi_done(xs);
2078fa17e47Spooka }
2088fa17e47Spooka 
2098fa17e47Spooka int
scsitest_match(device_t parent,cfdata_t match,void * aux)2108fa17e47Spooka scsitest_match(device_t parent, cfdata_t match, void *aux)
2118fa17e47Spooka {
2128fa17e47Spooka #ifdef USE_TOSI_ISO
2138fa17e47Spooka 	uint64_t fsize;
2148fa17e47Spooka 	int error, ft;
2158fa17e47Spooka 
2168fa17e47Spooka 	if (rumpuser_getfileinfo(MYCDISO, &fsize, &ft, &error))
2178fa17e47Spooka 		return 0;
2188fa17e47Spooka 	if (ft != RUMPUSER_FT_REG)
2198fa17e47Spooka 		return 0;
2208fa17e47Spooka 	mycdsize = fsize / CDBLOCKSIZE;
2218fa17e47Spooka 
2228fa17e47Spooka 	if ((isofd = rumpuser_open(MYCDISO, RUMPUSER_OPEN_RDWR, &error)) == -1)
2238fa17e47Spooka 		return 0;
2248fa17e47Spooka #else
2258fa17e47Spooka 	/*
2268fa17e47Spooka 	 * We pretend to have a medium present initially, so != -1.
2278fa17e47Spooka 	 */
2288fa17e47Spooka 	isofd = -2;
2298fa17e47Spooka #endif
2308fa17e47Spooka 
2318fa17e47Spooka 	return 1;
2328fa17e47Spooka }
2338fa17e47Spooka 
2348fa17e47Spooka void
scsitest_attach(device_t parent,device_t self,void * aux)2358fa17e47Spooka scsitest_attach(device_t parent, device_t self, void *aux)
2368fa17e47Spooka {
2378fa17e47Spooka 	struct scsitest *sc = device_private(self);
2388fa17e47Spooka 
2398fa17e47Spooka 	aprint_naive("\n");
2408fa17e47Spooka 	aprint_normal("\n");
2418fa17e47Spooka 
2428fa17e47Spooka 	memset(&sc->sc_adapter, 0, sizeof(sc->sc_adapter));
2438fa17e47Spooka 	sc->sc_adapter.adapt_nchannels = 1;
2448fa17e47Spooka 	sc->sc_adapter.adapt_request = scsitest_request;
2458fa17e47Spooka 	sc->sc_adapter.adapt_minphys = minphys;
2468fa17e47Spooka 	sc->sc_adapter.adapt_dev = self;
2478fa17e47Spooka 	sc->sc_adapter.adapt_max_periph = 1;
2488fa17e47Spooka 	sc->sc_adapter.adapt_openings = 1;
2498fa17e47Spooka 
2508fa17e47Spooka 	memset(&sc->sc_channel, 0, sizeof(sc->sc_channel));
2518fa17e47Spooka 	sc->sc_channel.chan_bustype = &scsi_bustype;
2528fa17e47Spooka 	sc->sc_channel.chan_ntargets = 2;
2538fa17e47Spooka 	sc->sc_channel.chan_nluns = 1;
2548fa17e47Spooka 	sc->sc_channel.chan_id = 0;
2558fa17e47Spooka 	sc->sc_channel.chan_flags = SCSIPI_CHAN_NOSETTLE;
2568fa17e47Spooka 	sc->sc_channel.chan_adapter = &sc->sc_adapter;
2578fa17e47Spooka 
258799aab80Sthorpej 	config_found(self, &sc->sc_channel, scsiprint,
259*05eb58f6Scjep 		CFARGS(.iattr = "scsi"));
2608fa17e47Spooka }
261