2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2014 Alexander Motin <mav@FreeBSD.org>
5 * Copyright (c) 2004, 2005 Silicon Graphics International Corp.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer,
13 * without modification, immediately at the beginning of the file.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/types.h>
38 #include <sys/module.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/malloc.h>
43 #include <sys/queue.h>
44 #include <sys/sysctl.h>
47 #include <cam/scsi/scsi_all.h>
48 #include <cam/scsi/scsi_da.h>
49 #include <cam/ctl/ctl_io.h>
50 #include <cam/ctl/ctl.h>
51 #include <cam/ctl/ctl_frontend.h>
52 #include <cam/ctl/ctl_util.h>
53 #include <cam/ctl/ctl_backend.h>
54 #include <cam/ctl/ctl_ioctl.h>
55 #include <cam/ctl/ctl_ha.h>
56 #include <cam/ctl/ctl_private.h>
57 #include <cam/ctl/ctl_debug.h>
58 #include <cam/ctl/ctl_scsi_all.h>
59 #include <cam/ctl/ctl_tpc.h>
60 #include <cam/ctl/ctl_error.h>
67 static struct tpcl_softc tpcl_softc;
69 static int tpcl_init(void);
70 static int tpcl_shutdown(void);
71 static void tpcl_datamove(union ctl_io *io);
72 static void tpcl_done(union ctl_io *io);
74 static struct ctl_frontend tpcl_frontend =
78 .shutdown = tpcl_shutdown,
80 CTL_FRONTEND_DECLARE(ctltpc, tpcl_frontend);
85 struct tpcl_softc *tsoftc = &tpcl_softc;
86 struct ctl_port *port;
87 struct scsi_transportid_spi *tid;
90 memset(tsoftc, 0, sizeof(*tsoftc));
93 port->frontend = &tpcl_frontend;
94 port->port_type = CTL_PORT_INTERNAL;
95 port->num_requested_ctl_io = 100;
96 port->port_name = "tpc";
97 port->fe_datamove = tpcl_datamove;
98 port->fe_done = tpcl_done;
100 port->max_initiators = 1;
102 if ((error = ctl_port_register(port)) != 0) {
103 printf("%s: tpc port registration failed\n", __func__);
107 len = sizeof(struct scsi_transportid_spi);
108 port->init_devid = malloc(sizeof(struct ctl_devid) + len,
109 M_CTL, M_WAITOK | M_ZERO);
110 port->init_devid->len = len;
111 tid = (struct scsi_transportid_spi *)port->init_devid->data;
112 tid->format_protocol = SCSI_TRN_SPI_FORMAT_DEFAULT | SCSI_PROTO_SPI;
113 scsi_ulto2b(0, tid->scsi_addr);
114 scsi_ulto2b(port->targ_port, tid->rel_trgt_port_id);
116 ctl_port_online(port);
123 struct tpcl_softc *tsoftc = &tpcl_softc;
124 struct ctl_port *port = &tsoftc->port;
127 ctl_port_offline(port);
128 if ((error = ctl_port_deregister(port)) != 0)
129 printf("%s: tpc port deregistration failed\n", __func__);
134 tpcl_datamove(union ctl_io *io)
136 struct ctl_sg_entry *ext_sglist, *kern_sglist;
137 struct ctl_sg_entry ext_entry, kern_entry;
138 int ext_sg_entries, kern_sg_entries;
139 int ext_sg_start, ext_offset;
141 int kern_watermark, ext_watermark;
142 struct ctl_scsiio *ctsio;
145 CTL_DEBUG_PRINT(("%s\n", __func__));
150 * If this is the case, we're probably doing a BBR read and don't
151 * actually need to transfer the data. This will effectively
152 * bit-bucket the data.
154 if (ctsio->ext_data_ptr == NULL)
158 * To simplify things here, if we have a single buffer, stick it in
159 * a S/G entry and just make it a single entry S/G list.
161 if (ctsio->ext_sg_entries > 0) {
164 ext_sglist = (struct ctl_sg_entry *)ctsio->ext_data_ptr;
165 ext_sg_entries = ctsio->ext_sg_entries;
169 for (i = 0; i < ext_sg_entries; i++) {
170 if ((len_seen + ext_sglist[i].len) >=
171 ctsio->ext_data_filled) {
173 ext_offset = ctsio->ext_data_filled - len_seen;
176 len_seen += ext_sglist[i].len;
179 ext_sglist = &ext_entry;
180 ext_sglist->addr = ctsio->ext_data_ptr;
181 ext_sglist->len = ctsio->ext_data_len;
184 ext_offset = ctsio->ext_data_filled;
187 if (ctsio->kern_sg_entries > 0) {
188 kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr;
189 kern_sg_entries = ctsio->kern_sg_entries;
191 kern_sglist = &kern_entry;
192 kern_sglist->addr = ctsio->kern_data_ptr;
193 kern_sglist->len = ctsio->kern_data_len;
198 ext_watermark = ext_offset;
199 for (i = ext_sg_start, j = 0;
200 i < ext_sg_entries && j < kern_sg_entries;) {
201 uint8_t *ext_ptr, *kern_ptr;
203 len_to_copy = min(ext_sglist[i].len - ext_watermark,
204 kern_sglist[j].len - kern_watermark);
206 ext_ptr = (uint8_t *)ext_sglist[i].addr;
207 ext_ptr = ext_ptr + ext_watermark;
208 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
212 panic("need to implement bus address support");
214 kern_ptr = bus_to_virt(kern_sglist[j].addr);
217 kern_ptr = (uint8_t *)kern_sglist[j].addr;
218 kern_ptr = kern_ptr + kern_watermark;
220 if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
222 CTL_DEBUG_PRINT(("%s: copying %d bytes to user\n",
223 __func__, len_to_copy));
224 CTL_DEBUG_PRINT(("%s: from %p to %p\n", __func__,
226 memcpy(ext_ptr, kern_ptr, len_to_copy);
228 CTL_DEBUG_PRINT(("%s: copying %d bytes from user\n",
229 __func__, len_to_copy));
230 CTL_DEBUG_PRINT(("%s: from %p to %p\n", __func__,
232 memcpy(kern_ptr, ext_ptr, len_to_copy);
235 ctsio->ext_data_filled += len_to_copy;
236 ctsio->kern_data_resid -= len_to_copy;
238 ext_watermark += len_to_copy;
239 if (ext_sglist[i].len == ext_watermark) {
244 kern_watermark += len_to_copy;
245 if (kern_sglist[j].len == kern_watermark) {
251 CTL_DEBUG_PRINT(("%s: ext_sg_entries: %d, kern_sg_entries: %d\n",
252 __func__, ext_sg_entries, kern_sg_entries));
253 CTL_DEBUG_PRINT(("%s: ext_data_len = %d, kern_data_len = %d\n",
254 __func__, ctsio->ext_data_len, ctsio->kern_data_len));
257 ctl_datamove_done(io, true);
261 tpcl_done(union ctl_io *io)
268 tpcl_resolve(struct ctl_softc *softc, int init_port,
269 struct scsi_ec_cscd *cscd, uint32_t *ss, uint32_t *ps, uint32_t *pso)
271 struct scsi_ec_cscd_id *cscdid;
272 struct ctl_port *port;
274 uint64_t lunid = UINT64_MAX;
276 if (cscd->type_code != EC_CSCD_ID ||
277 (cscd->luidt_pdt & EC_LUIDT_MASK) != EC_LUIDT_LUN ||
278 (cscd->luidt_pdt & EC_NUL) != 0)
281 cscdid = (struct scsi_ec_cscd_id *)cscd;
282 mtx_lock(&softc->ctl_lock);
284 port = softc->ctl_ports[init_port];
287 STAILQ_FOREACH(lun, &softc->lun_list, links) {
289 ctl_lun_map_to_port(port, lun->lun) == UINT32_MAX)
291 if (lun->lun_devid == NULL)
293 if (scsi_devid_match(lun->lun_devid->data,
294 lun->lun_devid->len, &cscdid->codeset,
295 cscdid->length + 4) == 0) {
298 *ss = lun->be_lun->blocksize;
300 *ps = lun->be_lun->blocksize <<
301 lun->be_lun->pblockexp;
303 *pso = lun->be_lun->blocksize *
304 lun->be_lun->pblockoff;
308 mtx_unlock(&softc->ctl_lock);
315 struct tpcl_softc *tsoftc = &tpcl_softc;
317 return (ctl_alloc_io(tsoftc->port.ctl_pool_ref));
321 tpcl_queue(union ctl_io *io, uint64_t lun)
323 struct tpcl_softc *tsoftc = &tpcl_softc;
325 io->io_hdr.nexus.initid = 0;
326 io->io_hdr.nexus.targ_port = tsoftc->port.targ_port;
327 io->io_hdr.nexus.targ_lun = lun;
328 io->scsiio.tag_num = atomic_fetchadd_int(&tsoftc->cur_tag_num, 1);
329 io->scsiio.ext_data_filled = 0;
330 return (ctl_queue(io));