1/*-
2 * Implementation of SCSI Processor Target Peripheral driver for CAM.
3 *
4 * Copyright (c) 1998 Justin T. Gibbs.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#include <sys/cdefs.h>
30__FBSDID("$FreeBSD: head/sys/cam/scsi/scsi_pt.c 168752 2007-04-15 08:49:19Z scottl $");
31
32#include <sys/param.h>
33#include <sys/queue.h>
34#include <sys/systm.h>
35#include <sys/kernel.h>
36#include <sys/types.h>
37#include <sys/bio.h>
38#include <sys/devicestat.h>
39#include <sys/malloc.h>
40#include <sys/conf.h>
41#include <sys/ptio.h>
42
43#include <cam/cam.h>
44#include <cam/cam_ccb.h>
45#include <cam/cam_periph.h>
46#include <cam/cam_xpt_periph.h>
47#include <cam/cam_debug.h>
48
49#include <cam/scsi/scsi_all.h>
50#include <cam/scsi/scsi_message.h>
51#include <cam/scsi/scsi_pt.h>
52
53#include "opt_pt.h"
54
55typedef enum {
56 PT_STATE_PROBE,
57 PT_STATE_NORMAL
58} pt_state;
59
60typedef enum {
61 PT_FLAG_NONE = 0x00,
62 PT_FLAG_OPEN = 0x01,
63 PT_FLAG_DEVICE_INVALID = 0x02,
64 PT_FLAG_RETRY_UA = 0x04
65} pt_flags;
66
67typedef enum {
68 PT_CCB_BUFFER_IO = 0x01,
69 PT_CCB_WAITING = 0x02,
70 PT_CCB_RETRY_UA = 0x04,
71 PT_CCB_BUFFER_IO_UA = PT_CCB_BUFFER_IO|PT_CCB_RETRY_UA
72} pt_ccb_state;
73
74/* Offsets into our private area for storing information */
75#define ccb_state ppriv_field0
76#define ccb_bp ppriv_ptr1
77
78struct pt_softc {
79 struct bio_queue_head bio_queue;
80 struct devstat *device_stats;
81 LIST_HEAD(, ccb_hdr) pending_ccbs;
82 pt_state state;
83 pt_flags flags;
84 union ccb saved_ccb;
85 int io_timeout;
86 struct cdev *dev;
87};
88
89static d_open_t ptopen;
90static d_close_t ptclose;
91static d_strategy_t ptstrategy;
92static periph_init_t ptinit;
93static void ptasync(void *callback_arg, u_int32_t code,
94 struct cam_path *path, void *arg);
95static periph_ctor_t ptctor;
96static periph_oninv_t ptoninvalidate;
97static periph_dtor_t ptdtor;
98static periph_start_t ptstart;
99static void ptdone(struct cam_periph *periph,
100 union ccb *done_ccb);
101static d_ioctl_t ptioctl;
102static int pterror(union ccb *ccb, u_int32_t cam_flags,
103 u_int32_t sense_flags);
104
105void scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries,
106 void (*cbfcnp)(struct cam_periph *, union ccb *),
107 u_int tag_action, int readop, u_int byte2,
108 u_int32_t xfer_len, u_int8_t *data_ptr,
109 u_int8_t sense_len, u_int32_t timeout);
110
111static struct periph_driver ptdriver =
112{
113 ptinit, "pt",
114 TAILQ_HEAD_INITIALIZER(ptdriver.units), /* generation */ 0
115};
116
117PERIPHDRIVER_DECLARE(pt, ptdriver);
118
119
120static struct cdevsw pt_cdevsw = {
121 .d_version = D_VERSION,
122 .d_flags = 0,
123 .d_open = ptopen,
124 .d_close = ptclose,
125 .d_read = physread,
126 .d_write = physwrite,
127 .d_ioctl = ptioctl,
128 .d_strategy = ptstrategy,
129 .d_name = "pt",
130};
131
132#ifndef SCSI_PT_DEFAULT_TIMEOUT
133#define SCSI_PT_DEFAULT_TIMEOUT 60
134#endif
135
136static int
137ptopen(struct cdev *dev, int flags, int fmt, struct thread *td)
138{
139 struct cam_periph *periph;
140 struct pt_softc *softc;
141 int error = 0;
142
143 periph = (struct cam_periph *)dev->si_drv1;
144 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
145 return (ENXIO);
146
147 softc = (struct pt_softc *)periph->softc;
148
149 cam_periph_lock(periph);
150 if (softc->flags & PT_FLAG_DEVICE_INVALID) {
151 cam_periph_unlock(periph);
152 cam_periph_release(periph);
153 return(ENXIO);
154 }
155
156 if ((softc->flags & PT_FLAG_OPEN) == 0)
157 softc->flags |= PT_FLAG_OPEN;
158 else {
159 error = EBUSY;
160 cam_periph_release(periph);
161 }
162
163 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
164 ("ptopen: dev=%s\n", devtoname(dev)));
165
166 cam_periph_unlock(periph);
167 return (error);
168}
169
170static int
171ptclose(struct cdev *dev, int flag, int fmt, struct thread *td)
172{
173 struct cam_periph *periph;
174 struct pt_softc *softc;
175
176 periph = (struct cam_periph *)dev->si_drv1;
177 if (periph == NULL)
178 return (ENXIO);
179
180 softc = (struct pt_softc *)periph->softc;
181
182 cam_periph_lock(periph);
183
184 softc->flags &= ~PT_FLAG_OPEN;
185 cam_periph_unlock(periph);
186 cam_periph_release(periph);
187 return (0);
188}
189
190/*
191 * Actually translate the requested transfer into one the physical driver
192 * can understand. The transfer is described by a buf and will include
193 * only one physical transfer.
194 */
195static void
196ptstrategy(struct bio *bp)
197{
198 struct cam_periph *periph;
199 struct pt_softc *softc;
200
201 periph = (struct cam_periph *)bp->bio_dev->si_drv1;
202 bp->bio_resid = bp->bio_bcount;
203 if (periph == NULL) {
204 biofinish(bp, NULL, ENXIO);
205 return;
206 }
207 cam_periph_lock(periph);
208 softc = (struct pt_softc *)periph->softc;
209
210 /*
211 * If the device has been made invalid, error out
212 */
213 if ((softc->flags & PT_FLAG_DEVICE_INVALID)) {
214 cam_periph_unlock(periph);
215 biofinish(bp, NULL, ENXIO);
216 return;
217 }
218
219 /*
220 * Place it in the queue of disk activities for this disk
221 */
222 bioq_insert_tail(&softc->bio_queue, bp);
223
224 /*
225 * Schedule ourselves for performing the work.
226 */
227 xpt_schedule(periph, /* XXX priority */1);
228 cam_periph_unlock(periph);
229
230 return;
231}
232
233static void
234ptinit(void)
235{
236 cam_status status;
237 struct cam_path *path;
238
239 /*
240 * Install a global async callback. This callback will
241 * receive async callbacks like "new device found".
242 */
243 status = xpt_create_path(&path, /*periph*/NULL, CAM_XPT_PATH_ID,
244 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
245
246 if (status == CAM_REQ_CMP) {
247 struct ccb_setasync csa;
248
249 xpt_setup_ccb(&csa.ccb_h, path, /*priority*/5);
250 csa.ccb_h.func_code = XPT_SASYNC_CB;
251 csa.event_enable = AC_FOUND_DEVICE;
252 csa.callback = ptasync;
253 csa.callback_arg = NULL;
254 xpt_action((union ccb *)&csa);
255 status = csa.ccb_h.status;
256 xpt_free_path(path);
257 }
258
259 if (status != CAM_REQ_CMP) {
260 printf("pt: Failed to attach master async callback "
261 "due to status 0x%x!\n", status);
262 }
263}
264
265static cam_status
266ptctor(struct cam_periph *periph, void *arg)
267{
268 struct pt_softc *softc;
269 struct ccb_setasync csa;
270 struct ccb_getdev *cgd;
271
272 cgd = (struct ccb_getdev *)arg;
273 if (periph == NULL) {
274 printf("ptregister: periph was NULL!!\n");
275 return(CAM_REQ_CMP_ERR);
276 }
277
278 if (cgd == NULL) {
279 printf("ptregister: no getdev CCB, can't register device\n");
280 return(CAM_REQ_CMP_ERR);
281 }
282
283 softc = (struct pt_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
284
285 if (softc == NULL) {
286 printf("daregister: Unable to probe new device. "
287 "Unable to allocate softc\n");
288 return(CAM_REQ_CMP_ERR);
289 }
290
291 bzero(softc, sizeof(*softc));
292 LIST_INIT(&softc->pending_ccbs);
293 softc->state = PT_STATE_NORMAL;
294 bioq_init(&softc->bio_queue);
295
296 softc->io_timeout = SCSI_PT_DEFAULT_TIMEOUT * 1000;
297
298 periph->softc = softc;
299
300 softc->device_stats = devstat_new_entry("pt",
301 periph->unit_number, 0,
302 DEVSTAT_NO_BLOCKSIZE,
303 SID_TYPE(&cgd->inq_data) | DEVSTAT_TYPE_IF_SCSI,
304 DEVSTAT_PRIORITY_OTHER);
305
306 softc->dev = make_dev(&pt_cdevsw, periph->unit_number, UID_ROOT,
307 GID_OPERATOR, 0600, "%s%d", periph->periph_name,
308 periph->unit_number);
309 softc->dev->si_drv1 = periph;
310
311 /*
312 * Add async callbacks for bus reset and
313 * bus device reset calls. I don't bother
314 * checking if this fails as, in most cases,
315 * the system will function just fine without
316 * them and the only alternative would be to
317 * not attach the device on failure.
318 */
319 xpt_setup_ccb(&csa.ccb_h, periph->path, /*priority*/5);
320 csa.ccb_h.func_code = XPT_SASYNC_CB;
321 csa.event_enable = AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE;
322 csa.callback = ptasync;
323 csa.callback_arg = periph;
324 xpt_action((union ccb *)&csa);
325
326 /* Tell the user we've attached to the device */
327 xpt_announce_periph(periph, NULL);
328
329 return(CAM_REQ_CMP);
330}
331
332static void
333ptoninvalidate(struct cam_periph *periph)
334{
335 struct pt_softc *softc;
336 struct ccb_setasync csa;
337
338 softc = (struct pt_softc *)periph->softc;
339
340 /*
341 * De-register any async callbacks.
342 */
343 xpt_setup_ccb(&csa.ccb_h, periph->path,
344 /* priority */ 5);
345 csa.ccb_h.func_code = XPT_SASYNC_CB;
346 csa.event_enable = 0;
347 csa.callback = ptasync;
348 csa.callback_arg = periph;
349 xpt_action((union ccb *)&csa);
350
351 softc->flags |= PT_FLAG_DEVICE_INVALID;
352
353 /*
354 * Return all queued I/O with ENXIO.
355 * XXX Handle any transactions queued to the card
356 * with XPT_ABORT_CCB.
357 */
358 bioq_flush(&softc->bio_queue, NULL, ENXIO);
359
360 xpt_print(periph->path, "lost device\n");
361}
362
363static void
364ptdtor(struct cam_periph *periph)
365{
366 struct pt_softc *softc;
367
368 softc = (struct pt_softc *)periph->softc;
369
370 devstat_remove_entry(softc->device_stats);
371
372 destroy_dev(softc->dev);
373
374 xpt_print(periph->path, "removing device entry\n");
375 free(softc, M_DEVBUF);
376}
377
378static void
379ptasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
380{
381 struct cam_periph *periph;
382
383 periph = (struct cam_periph *)callback_arg;
384 switch (code) {
385 case AC_FOUND_DEVICE:
386 {
387 struct ccb_getdev *cgd;
388 cam_status status;
389
390 cgd = (struct ccb_getdev *)arg;
391 if (cgd == NULL)
392 break;
393
394 if (SID_TYPE(&cgd->inq_data) != T_PROCESSOR)
395 break;
396
397 /*
398 * Allocate a peripheral instance for
399 * this device and start the probe
400 * process.
401 */
402 status = cam_periph_alloc(ptctor, ptoninvalidate, ptdtor,
403 ptstart, "pt", CAM_PERIPH_BIO,
404 cgd->ccb_h.path, ptasync,
405 AC_FOUND_DEVICE, cgd);
406
407 if (status != CAM_REQ_CMP
408 && status != CAM_REQ_INPROG)
409 printf("ptasync: Unable to attach to new device "
410 "due to status 0x%x\n", status);
411 break;
412 }
413 case AC_SENT_BDR:
414 case AC_BUS_RESET:
415 {
416 struct pt_softc *softc;
417 struct ccb_hdr *ccbh;
418
419 softc = (struct pt_softc *)periph->softc;
420 /*
421 * Don't fail on the expected unit attention
422 * that will occur.
423 */
424 softc->flags |= PT_FLAG_RETRY_UA;
425 LIST_FOREACH(ccbh, &softc->pending_ccbs, periph_links.le)
426 ccbh->ccb_state |= PT_CCB_RETRY_UA;
427 }
428 /* FALLTHROUGH */
429 default:
430 cam_periph_async(periph, code, path, arg);
431 break;
432 }
433}
434
435static void
436ptstart(struct cam_periph *periph, union ccb *start_ccb)
437{
438 struct pt_softc *softc;
439 struct bio *bp;
440
441 softc = (struct pt_softc *)periph->softc;
442
443 /*
444 * See if there is a buf with work for us to do..
445 */
446 bp = bioq_first(&softc->bio_queue);
447 if (periph->immediate_priority <= periph->pinfo.priority) {
448 CAM_DEBUG_PRINT(CAM_DEBUG_SUBTRACE,
449 ("queuing for immediate ccb\n"));
450 start_ccb->ccb_h.ccb_state = PT_CCB_WAITING;
451 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
452 periph_links.sle);
453 periph->immediate_priority = CAM_PRIORITY_NONE;
454 wakeup(&periph->ccb_list);
455 } else if (bp == NULL) {
456 xpt_release_ccb(start_ccb);
457 } else {
458 bioq_remove(&softc->bio_queue, bp);
459
460 devstat_start_transaction_bio(softc->device_stats, bp);
461
462 scsi_send_receive(&start_ccb->csio,
463 /*retries*/4,
464 ptdone,
465 MSG_SIMPLE_Q_TAG,
466 bp->bio_cmd == BIO_READ,
467 /*byte2*/0,
468 bp->bio_bcount,
469 bp->bio_data,
470 /*sense_len*/SSD_FULL_SIZE,
471 /*timeout*/softc->io_timeout);
472
473 start_ccb->ccb_h.ccb_state = PT_CCB_BUFFER_IO_UA;
474
475 /*
476 * Block out any asyncronous callbacks
477 * while we touch the pending ccb list.
478 */
479 LIST_INSERT_HEAD(&softc->pending_ccbs, &start_ccb->ccb_h,
480 periph_links.le);
481
482 start_ccb->ccb_h.ccb_bp = bp;
483 bp = bioq_first(&softc->bio_queue);
484
485 xpt_action(start_ccb);
486
487 if (bp != NULL) {
488 /* Have more work to do, so ensure we stay scheduled */
489 xpt_schedule(periph, /* XXX priority */1);
490 }
491 }
492}
493
494static void
495ptdone(struct cam_periph *periph, union ccb *done_ccb)
496{
497 struct pt_softc *softc;
498 struct ccb_scsiio *csio;
499
500 softc = (struct pt_softc *)periph->softc;
501 csio = &done_ccb->csio;
502 switch (csio->ccb_h.ccb_state) {
503 case PT_CCB_BUFFER_IO:
504 case PT_CCB_BUFFER_IO_UA:
505 {
506 struct bio *bp;
507
508 bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
509 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
510 int error;
511 int sf;
512
513 if ((csio->ccb_h.ccb_state & PT_CCB_RETRY_UA) != 0)
514 sf = SF_RETRY_UA;
515 else
516 sf = 0;
517
518 error = pterror(done_ccb, CAM_RETRY_SELTO, sf);
519 if (error == ERESTART) {
520 /*
521 * A retry was scheuled, so
522 * just return.
523 */
524 return;
525 }
526 if (error != 0) {
527 if (error == ENXIO) {
528 /*
529 * Catastrophic error. Mark our device
530 * as invalid.
531 */
532 xpt_print(periph->path,
533 "Invalidating device\n");
534 softc->flags |= PT_FLAG_DEVICE_INVALID;
535 }
536
537 /*
538 * return all queued I/O with EIO, so that
539 * the client can retry these I/Os in the
540 * proper order should it attempt to recover.
541 */
542 bioq_flush(&softc->bio_queue, NULL, EIO);
543 bp->bio_error = error;
544 bp->bio_resid = bp->bio_bcount;
545 bp->bio_flags |= BIO_ERROR;
546 } else {
547 bp->bio_resid = csio->resid;
548 bp->bio_error = 0;
549 if (bp->bio_resid != 0) {
550 /* Short transfer ??? */
551 bp->bio_flags |= BIO_ERROR;
552 }
553 }
554 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
555 cam_release_devq(done_ccb->ccb_h.path,
556 /*relsim_flags*/0,
557 /*reduction*/0,
558 /*timeout*/0,
559 /*getcount_only*/0);
560 } else {
561 bp->bio_resid = csio->resid;
562 if (bp->bio_resid != 0)
563 bp->bio_flags |= BIO_ERROR;
564 }
565
566 /*
567 * Block out any asyncronous callbacks
568 * while we touch the pending ccb list.
569 */
570 LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
571
572 biofinish(bp, softc->device_stats, 0);
573 break;
574 }
575 case PT_CCB_WAITING:
576 /* Caller will release the CCB */
577 wakeup(&done_ccb->ccb_h.cbfcnp);
578 return;
579 }
580 xpt_release_ccb(done_ccb);
581}
582
583static int
584pterror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
585{
586 struct pt_softc *softc;
587 struct cam_periph *periph;
588
589 periph = xpt_path_periph(ccb->ccb_h.path);
590 softc = (struct pt_softc *)periph->softc;
591
592 return(cam_periph_error(ccb, cam_flags, sense_flags,
593 &softc->saved_ccb));
594}
595
596static int
597ptioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
598{
599 struct cam_periph *periph;
600 struct pt_softc *softc;
601 int error = 0;
602
603 periph = (struct cam_periph *)dev->si_drv1;
604 if (periph == NULL)
605 return(ENXIO);
606
607 softc = (struct pt_softc *)periph->softc;
608
609 cam_periph_lock(periph);
610
611 switch(cmd) {
612 case PTIOCGETTIMEOUT:
613 if (softc->io_timeout >= 1000)
614 *(int *)addr = softc->io_timeout / 1000;
615 else
616 *(int *)addr = 0;
617 break;
618 case PTIOCSETTIMEOUT:
619 if (*(int *)addr < 1) {
620 error = EINVAL;
621 break;
622 }
623
624 softc->io_timeout = *(int *)addr * 1000;
625
626 break;
627 default:
628 error = cam_periph_ioctl(periph, cmd, addr, pterror);
629 break;
630 }
631
632 cam_periph_unlock(periph);
633
634 return(error);
635}
636
637void
638scsi_send_receive(struct ccb_scsiio *csio, u_int32_t retries,
639 void (*cbfcnp)(struct cam_periph *, union ccb *),
640 u_int tag_action, int readop, u_int byte2,
641 u_int32_t xfer_len, u_int8_t *data_ptr, u_int8_t sense_len,
642 u_int32_t timeout)
643{
644 struct scsi_send_receive *scsi_cmd;
645
646 scsi_cmd = (struct scsi_send_receive *)&csio->cdb_io.cdb_bytes;
647 scsi_cmd->opcode = readop ? RECEIVE : SEND;
648 scsi_cmd->byte2 = byte2;
649 scsi_ulto3b(xfer_len, scsi_cmd->xfer_len);
650 scsi_cmd->control = 0;
651
652 cam_fill_csio(csio,
653 retries,
654 cbfcnp,
655 /*flags*/readop ? CAM_DIR_IN : CAM_DIR_OUT,
656 tag_action,
657 data_ptr,
658 xfer_len,
659 sense_len,
660 sizeof(*scsi_cmd),
661 timeout);
662}