1/*-
2 * Copyright (c) 2000 Matthew Jacob
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. The name of the author may not be used to endorse or promote products
12 * derived from this software without specific prior written permission.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: head/sys/cam/scsi/scsi_enc.c 291126 2015-11-21 10:22:01Z mav $");
29
30#include <sys/param.h>
31
32#include <sys/conf.h>
33#include <sys/errno.h>
34#include <sys/fcntl.h>
35#include <sys/kernel.h>
36#include <sys/kthread.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/queue.h>
41#include <sys/sx.h>
42#include <sys/systm.h>
43#include <sys/sysctl.h>
44#include <sys/types.h>
45
46#include <machine/stdarg.h>
47
48#include <cam/cam.h>
49#include <cam/cam_ccb.h>
50#include <cam/cam_debug.h>
51#include <cam/cam_periph.h>
52#include <cam/cam_xpt_periph.h>
53
54#include <cam/scsi/scsi_all.h>
55#include <cam/scsi/scsi_message.h>
56#include <cam/scsi/scsi_enc.h>
57#include <cam/scsi/scsi_enc_internal.h>
58
59#include <opt_ses.h>
60
61MALLOC_DEFINE(M_SCSIENC, "SCSI ENC", "SCSI ENC buffers");
62
63/* Enclosure type independent driver */
64
65static d_open_t enc_open;
66static d_close_t enc_close;
67static d_ioctl_t enc_ioctl;
68static periph_init_t enc_init;
69static periph_ctor_t enc_ctor;
70static periph_oninv_t enc_oninvalidate;
71static periph_dtor_t enc_dtor;
72
73static void enc_async(void *, uint32_t, struct cam_path *, void *);
74static enctyp enc_type(struct ccb_getdev *);
75
76SYSCTL_NODE(_kern_cam, OID_AUTO, enc, CTLFLAG_RD, 0,
77 "CAM Enclosure Services driver");
78
79static struct periph_driver encdriver = {
80 enc_init, "ses",
81 TAILQ_HEAD_INITIALIZER(encdriver.units), /* generation */ 0
82};
83
84PERIPHDRIVER_DECLARE(enc, encdriver);
85
86static struct cdevsw enc_cdevsw = {
87 .d_version = D_VERSION,
88 .d_open = enc_open,
89 .d_close = enc_close,
90 .d_ioctl = enc_ioctl,
91 .d_name = "ses",
92 .d_flags = D_TRACKCLOSE,
93};
94
95static void
96enc_init(void)
97{
98 cam_status status;
99
100 /*
101 * Install a global async callback. This callback will
102 * receive async callbacks like "new device found".
103 */
104 status = xpt_register_async(AC_FOUND_DEVICE, enc_async, NULL, NULL);
105
106 if (status != CAM_REQ_CMP) {
107 printf("enc: Failed to attach master async callback "
108 "due to status 0x%x!\n", status);
109 }
110}
111
112static void
113enc_devgonecb(void *arg)
114{
115 struct cam_periph *periph;
116 struct enc_softc *enc;
117 struct mtx *mtx;
118 int i;
119
120 periph = (struct cam_periph *)arg;
121 mtx = cam_periph_mtx(periph);
122 mtx_lock(mtx);
123 enc = (struct enc_softc *)periph->softc;
124
125 /*
126 * When we get this callback, we will get no more close calls from
127 * devfs. So if we have any dangling opens, we need to release the
128 * reference held for that particular context.
129 */
130 for (i = 0; i < enc->open_count; i++)
131 cam_periph_release_locked(periph);
132
133 enc->open_count = 0;
134
135 /*
136 * Release the reference held for the device node, it is gone now.
137 */
138 cam_periph_release_locked(periph);
139
140 /*
141 * We reference the lock directly here, instead of using
142 * cam_periph_unlock(). The reason is that the final call to
143 * cam_periph_release_locked() above could result in the periph
144 * getting freed. If that is the case, dereferencing the periph
145 * with a cam_periph_unlock() call would cause a page fault.
146 */
147 mtx_unlock(mtx);
148}
149
150static void
151enc_oninvalidate(struct cam_periph *periph)
152{
153 struct enc_softc *enc;
154
155 enc = periph->softc;
156
157 enc->enc_flags |= ENC_FLAG_INVALID;
158
159 /* If the sub-driver has an invalidate routine, call it */
160 if (enc->enc_vec.softc_invalidate != NULL)
161 enc->enc_vec.softc_invalidate(enc);
162
163 /*
164 * Unregister any async callbacks.
165 */
166 xpt_register_async(0, enc_async, periph, periph->path);
167
168 /*
169 * Shutdown our daemon.
170 */
171 enc->enc_flags |= ENC_FLAG_SHUTDOWN;
172 if (enc->enc_daemon != NULL) {
173 /* Signal the ses daemon to terminate. */
174 wakeup(enc->enc_daemon);
175 }
176 callout_drain(&enc->status_updater);
177
178 destroy_dev_sched_cb(enc->enc_dev, enc_devgonecb, periph);
179}
180
181static void
182enc_dtor(struct cam_periph *periph)
183{
184 struct enc_softc *enc;
185
186 enc = periph->softc;
187
188 /* If the sub-driver has a cleanup routine, call it */
189 if (enc->enc_vec.softc_cleanup != NULL)
190 enc->enc_vec.softc_cleanup(enc);
191
192 if (enc->enc_boot_hold_ch.ich_func != NULL) {
193 config_intrhook_disestablish(&enc->enc_boot_hold_ch);
194 enc->enc_boot_hold_ch.ich_func = NULL;
195 }
196
197 ENC_FREE(enc);
198}
199
200static void
201enc_async(void *callback_arg, uint32_t code, struct cam_path *path, void *arg)
202{
203 struct cam_periph *periph;
204
205 periph = (struct cam_periph *)callback_arg;
206
207 switch(code) {
208 case AC_FOUND_DEVICE:
209 {
210 struct ccb_getdev *cgd;
211 cam_status status;
212 path_id_t path_id;
213
214 cgd = (struct ccb_getdev *)arg;
215 if (arg == NULL) {
216 break;
217 }
218
219 if (enc_type(cgd) == ENC_NONE) {
220 /*
221 * Schedule announcement of the ENC bindings for
222 * this device if it is managed by a SEP.
223 */
224 path_id = xpt_path_path_id(path);
225 xpt_lock_buses();
226 TAILQ_FOREACH(periph, &encdriver.units, unit_links) {
227 struct enc_softc *softc;
228
229 softc = (struct enc_softc *)periph->softc;
230 if (xpt_path_path_id(periph->path) != path_id
231 || softc == NULL
232 || (softc->enc_flags & ENC_FLAG_INITIALIZED)
233 == 0
234 || softc->enc_vec.device_found == NULL)
235 continue;
236
237 softc->enc_vec.device_found(softc);
238 }
239 xpt_unlock_buses();
240 return;
241 }
242
243 status = cam_periph_alloc(enc_ctor, enc_oninvalidate,
244 enc_dtor, NULL, "ses", CAM_PERIPH_BIO,
245 path, enc_async, AC_FOUND_DEVICE, cgd);
246
247 if (status != CAM_REQ_CMP && status != CAM_REQ_INPROG) {
248 printf("enc_async: Unable to probe new device due to "
249 "status 0x%x\n", status);
250 }
251 break;
252 }
253 default:
254 cam_periph_async(periph, code, path, arg);
255 break;
256 }
257}
258
259static int
260enc_open(struct cdev *dev, int flags, int fmt, struct thread *td)
261{
262 struct cam_periph *periph;
263 struct enc_softc *softc;
264 int error = 0;
265
266 periph = (struct cam_periph *)dev->si_drv1;
267 if (periph == NULL) {
268 return (ENXIO);
269 }
270
271 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
272 return (ENXIO);
273
274 cam_periph_lock(periph);
275
276 softc = (struct enc_softc *)periph->softc;
277
278 if ((softc->enc_flags & ENC_FLAG_INITIALIZED) == 0) {
279 error = ENXIO;
280 goto out;
281 }
282 if (softc->enc_flags & ENC_FLAG_INVALID) {
283 error = ENXIO;
284 goto out;
285 }
286out:
287 if (error != 0)
288 cam_periph_release_locked(periph);
289 else
290 softc->open_count++;
291
292 cam_periph_unlock(periph);
293
294 return (error);
295}
296
297static int
298enc_close(struct cdev *dev, int flag, int fmt, struct thread *td)
299{
300 struct cam_periph *periph;
301 struct enc_softc *enc;
302 struct mtx *mtx;
303
304 periph = (struct cam_periph *)dev->si_drv1;
305 if (periph == NULL)
306 return (ENXIO);
307 mtx = cam_periph_mtx(periph);
308 mtx_lock(mtx);
309
310 enc = periph->softc;
311 enc->open_count--;
312
313 cam_periph_release_locked(periph);
314
315 /*
316 * We reference the lock directly here, instead of using
317 * cam_periph_unlock(). The reason is that the call to
318 * cam_periph_release_locked() above could result in the periph
319 * getting freed. If that is the case, dereferencing the periph
320 * with a cam_periph_unlock() call would cause a page fault.
321 *
322 * cam_periph_release() avoids this problem using the same method,
323 * but we're manually acquiring and dropping the lock here to
324 * protect the open count and avoid another lock acquisition and
325 * release.
326 */
327 mtx_unlock(mtx);
328
329 return (0);
330}
331
332int
333enc_error(union ccb *ccb, uint32_t cflags, uint32_t sflags)
334{
335 struct enc_softc *softc;
336 struct cam_periph *periph;
337
338 periph = xpt_path_periph(ccb->ccb_h.path);
339 softc = (struct enc_softc *)periph->softc;
340
341 return (cam_periph_error(ccb, cflags, sflags, &softc->saved_ccb));
342}
343
344static int
345enc_ioctl(struct cdev *dev, u_long cmd, caddr_t arg_addr, int flag,
346 struct thread *td)
347{
348 struct cam_periph *periph;
349 encioc_enc_status_t tmp;
350 encioc_string_t sstr;
351 encioc_elm_status_t elms;
352 encioc_elm_desc_t elmd;
353 encioc_elm_devnames_t elmdn;
354 encioc_element_t *uelm;
355 enc_softc_t *enc;
356 enc_cache_t *cache;
357 void *addr;
358 int error, i;
359
360
361 if (arg_addr)
362 addr = *((caddr_t *) arg_addr);
363 else
364 addr = NULL;
365
366 periph = (struct cam_periph *)dev->si_drv1;
367 if (periph == NULL)
368 return (ENXIO);
369
370 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering encioctl\n"));
371
372 cam_periph_lock(periph);
373 enc = (struct enc_softc *)periph->softc;
374 cache = &enc->enc_cache;
375
376 /*
377 * Now check to see whether we're initialized or not.
378 * This actually should never fail as we're not supposed
379 * to get past enc_open w/o successfully initializing
380 * things.
381 */
382 if ((enc->enc_flags & ENC_FLAG_INITIALIZED) == 0) {
383 cam_periph_unlock(periph);
384 return (ENXIO);
385 }
386 cam_periph_unlock(periph);
387
388 error = 0;
389
390 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
391 ("trying to do ioctl %#lx\n", cmd));
392
393 /*
394 * If this command can change the device's state,
395 * we must have the device open for writing.
396 *
397 * For commands that get information about the
398 * device- we don't need to lock the peripheral
399 * if we aren't running a command. The periph
400 * also can't go away while a user process has
401 * it open.
402 */
403 switch (cmd) {
404 case ENCIOC_GETNELM:
405 case ENCIOC_GETELMMAP:
406 case ENCIOC_GETENCSTAT:
407 case ENCIOC_GETELMSTAT:
408 case ENCIOC_GETELMDESC:
409 case ENCIOC_GETELMDEVNAMES:
410 case ENCIOC_GETENCNAME:
411 case ENCIOC_GETENCID:
412 break;
413 default:
414 if ((flag & FWRITE) == 0) {
415 return (EBADF);
416 }
417 }
418
419 /*
420 * XXX The values read here are only valid for the current
421 * configuration generation. We need these ioctls
422 * to also pass in/out a generation number.
423 */
424 sx_slock(&enc->enc_cache_lock);
425 switch (cmd) {
426 case ENCIOC_GETNELM:
427 error = copyout(&cache->nelms, addr, sizeof (cache->nelms));
428 break;
429
430 case ENCIOC_GETELMMAP:
431 for (uelm = addr, i = 0; i != cache->nelms; i++) {
432 encioc_element_t kelm;
433 kelm.elm_idx = i;
434 kelm.elm_subenc_id = cache->elm_map[i].subenclosure;
435 kelm.elm_type = cache->elm_map[i].enctype;
436 error = copyout(&kelm, &uelm[i], sizeof(kelm));
437 if (error)
438 break;
439 }
440 break;
441
442 case ENCIOC_GETENCSTAT:
443 cam_periph_lock(periph);
444 error = enc->enc_vec.get_enc_status(enc, 1);
445 if (error) {
446 cam_periph_unlock(periph);
447 break;
448 }
449 tmp = cache->enc_status;
450 cam_periph_unlock(periph);
451 error = copyout(&tmp, addr, sizeof(tmp));
452 cache->enc_status = tmp;
453 break;
454
455 case ENCIOC_SETENCSTAT:
456 error = copyin(addr, &tmp, sizeof(tmp));
457 if (error)
458 break;
459 cam_periph_lock(periph);
460 error = enc->enc_vec.set_enc_status(enc, tmp, 1);
461 cam_periph_unlock(periph);
462 break;
463
464 case ENCIOC_GETSTRING:
465 case ENCIOC_SETSTRING:
466 case ENCIOC_GETENCNAME:
467 case ENCIOC_GETENCID:
468 if (enc->enc_vec.handle_string == NULL) {
469 error = EINVAL;
470 break;
471 }
472 error = copyin(addr, &sstr, sizeof(sstr));
473 if (error)
474 break;
475 cam_periph_lock(periph);
476 error = enc->enc_vec.handle_string(enc, &sstr, cmd);
477 cam_periph_unlock(periph);
478 break;
479
480 case ENCIOC_GETELMSTAT:
481 error = copyin(addr, &elms, sizeof(elms));
482 if (error)
483 break;
484 if (elms.elm_idx >= cache->nelms) {
485 error = EINVAL;
486 break;
487 }
488 cam_periph_lock(periph);
489 error = enc->enc_vec.get_elm_status(enc, &elms, 1);
490 cam_periph_unlock(periph);
491 if (error)
492 break;
493 error = copyout(&elms, addr, sizeof(elms));
494 break;
495
496 case ENCIOC_GETELMDESC:
497 error = copyin(addr, &elmd, sizeof(elmd));
498 if (error)
499 break;
500 if (elmd.elm_idx >= cache->nelms) {
501 error = EINVAL;
502 break;
503 }
504 if (enc->enc_vec.get_elm_desc != NULL) {
505 error = enc->enc_vec.get_elm_desc(enc, &elmd);
506 if (error)
507 break;
508 } else
509 elmd.elm_desc_len = 0;
510 error = copyout(&elmd, addr, sizeof(elmd));
511 break;
512
513 case ENCIOC_GETELMDEVNAMES:
514 if (enc->enc_vec.get_elm_devnames == NULL) {
515 error = EINVAL;
516 break;
517 }
518 error = copyin(addr, &elmdn, sizeof(elmdn));
519 if (error)
520 break;
521 if (elmdn.elm_idx >= cache->nelms) {
522 error = EINVAL;
523 break;
524 }
525 cam_periph_lock(periph);
526 error = (*enc->enc_vec.get_elm_devnames)(enc, &elmdn);
527 cam_periph_unlock(periph);
528 if (error)
529 break;
530 error = copyout(&elmdn, addr, sizeof(elmdn));
531 break;
532
533 case ENCIOC_SETELMSTAT:
534 error = copyin(addr, &elms, sizeof(elms));
535 if (error)
536 break;
537
538 if (elms.elm_idx >= cache->nelms) {
539 error = EINVAL;
540 break;
541 }
542 cam_periph_lock(periph);
543 error = enc->enc_vec.set_elm_status(enc, &elms, 1);
544 cam_periph_unlock(periph);
545
546 break;
547
548 case ENCIOC_INIT:
549
550 cam_periph_lock(periph);
551 error = enc->enc_vec.init_enc(enc);
552 cam_periph_unlock(periph);
553 break;
554
555 default:
556 cam_periph_lock(periph);
557 error = cam_periph_ioctl(periph, cmd, arg_addr, enc_error);
558 cam_periph_unlock(periph);
559 break;
560 }
561 sx_sunlock(&enc->enc_cache_lock);
562 return (error);
563}
564
565int
566enc_runcmd(struct enc_softc *enc, char *cdb, int cdbl, char *dptr, int *dlenp)
567{
568 int error, dlen, tdlen;
569 ccb_flags ddf;
570 union ccb *ccb;
571
572 CAM_DEBUG(enc->periph->path, CAM_DEBUG_TRACE,
573 ("entering enc_runcmd\n"));
574 if (dptr) {
575 if ((dlen = *dlenp) < 0) {
576 dlen = -dlen;
577 ddf = CAM_DIR_OUT;
578 } else {
579 ddf = CAM_DIR_IN;
580 }
581 } else {
582 dlen = 0;
583 ddf = CAM_DIR_NONE;
584 }
585
586 if (cdbl > IOCDBLEN) {
587 cdbl = IOCDBLEN;
588 }
589
590 ccb = cam_periph_getccb(enc->periph, CAM_PRIORITY_NORMAL);
591 if (enc->enc_type == ENC_SEMB_SES || enc->enc_type == ENC_SEMB_SAFT) {
592 tdlen = min(dlen, 1020);
593 tdlen = (tdlen + 3) & ~3;
594 cam_fill_ataio(&ccb->ataio, 0, NULL, ddf, 0, dptr, tdlen,
595 30 * 1000);
596 if (cdb[0] == RECEIVE_DIAGNOSTIC)
597 ata_28bit_cmd(&ccb->ataio,
598 ATA_SEP_ATTN, cdb[2], 0x02, tdlen / 4);
599 else if (cdb[0] == SEND_DIAGNOSTIC)
600 ata_28bit_cmd(&ccb->ataio,
601 ATA_SEP_ATTN, dlen > 0 ? dptr[0] : 0,
602 0x82, tdlen / 4);
603 else if (cdb[0] == READ_BUFFER)
604 ata_28bit_cmd(&ccb->ataio,
605 ATA_SEP_ATTN, cdb[2], 0x00, tdlen / 4);
606 else
607 ata_28bit_cmd(&ccb->ataio,
608 ATA_SEP_ATTN, dlen > 0 ? dptr[0] : 0,
609 0x80, tdlen / 4);
610 } else {
611 tdlen = dlen;
612 cam_fill_csio(&ccb->csio, 0, NULL, ddf, MSG_SIMPLE_Q_TAG,
613 dptr, dlen, sizeof (struct scsi_sense_data), cdbl,
614 60 * 1000);
615 bcopy(cdb, ccb->csio.cdb_io.cdb_bytes, cdbl);
616 }
617
618 error = cam_periph_runccb(ccb, enc_error, ENC_CFLAGS, ENC_FLAGS, NULL);
619 if (error) {
620 if (dptr) {
621 *dlenp = dlen;
622 }
623 } else {
624 if (dptr) {
625 if (ccb->ccb_h.func_code == XPT_ATA_IO)
626 *dlenp = ccb->ataio.resid;
627 else
628 *dlenp = ccb->csio.resid;
629 *dlenp += tdlen - dlen;
630 }
631 }
632 xpt_release_ccb(ccb);
633 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE,
634 ("exiting enc_runcmd: *dlenp = %d\n", *dlenp));
635 return (error);
636}
637
638void
639enc_log(struct enc_softc *enc, const char *fmt, ...)
640{
641 va_list ap;
642
643 printf("%s%d: ", enc->periph->periph_name, enc->periph->unit_number);
644 va_start(ap, fmt);
645 vprintf(fmt, ap);
646 va_end(ap);
647}
648
649/*
650 * The code after this point runs on many platforms,
651 * so forgive the slightly awkward and nonconforming
652 * appearance.
653 */
654
655/*
656 * Is this a device that supports enclosure services?
657 *
658 * It's a pretty simple ruleset- if it is device type
659 * 0x0D (13), it's an ENCLOSURE device.
660 */
661
662#define SAFTE_START 44
663#define SAFTE_END 50
664#define SAFTE_LEN SAFTE_END-SAFTE_START
665
666static enctyp
667enc_type(struct ccb_getdev *cgd)
668{
669 int buflen;
670 unsigned char *iqd;
671
672 if (cgd->protocol == PROTO_SEMB) {
673 iqd = (unsigned char *)&cgd->ident_data;
674 if (STRNCMP(iqd + 43, "S-E-S", 5) == 0)
675 return (ENC_SEMB_SES);
676 else if (STRNCMP(iqd + 43, "SAF-TE", 6) == 0)
677 return (ENC_SEMB_SAFT);
678 return (ENC_NONE);
679
680 } else if (cgd->protocol != PROTO_SCSI)
681 return (ENC_NONE);
682
683 iqd = (unsigned char *)&cgd->inq_data;
684 buflen = min(sizeof(cgd->inq_data),
685 SID_ADDITIONAL_LENGTH(&cgd->inq_data));
686
687 if ((iqd[0] & 0x1f) == T_ENCLOSURE) {
688 if ((iqd[2] & 0x7) > 2) {
689 return (ENC_SES);
690 } else {
691 return (ENC_SES_SCSI2);
692 }
693 return (ENC_NONE);
694 }
695
696#ifdef SES_ENABLE_PASSTHROUGH
697 if ((iqd[6] & 0x40) && (iqd[2] & 0x7) >= 2) {
698 /*
699 * PassThrough Device.
700 */
701 return (ENC_SES_PASSTHROUGH);
702 }
703#endif
704
705 /*
706 * The comparison is short for a reason-
707 * some vendors were chopping it short.
708 */
709
710 if (buflen < SAFTE_END - 2) {
711 return (ENC_NONE);
712 }
713
714 if (STRNCMP((char *)&iqd[SAFTE_START], "SAF-TE", SAFTE_LEN - 2) == 0) {
715 return (ENC_SAFT);
716 }
717 return (ENC_NONE);
718}
719
720/*================== Enclosure Monitoring/Processing Daemon ==================*/
721/**
722 * \brief Queue an update request for a given action, if needed.
723 *
724 * \param enc SES softc to queue the request for.
725 * \param action Action requested.
726 */
727void
728enc_update_request(enc_softc_t *enc, uint32_t action)
729{
730 if ((enc->pending_actions & (0x1 << action)) == 0) {
731 enc->pending_actions |= (0x1 << action);
732 ENC_DLOG(enc, "%s: queing requested action %d\n",
733 __func__, action);
734 if (enc->current_action == ENC_UPDATE_NONE)
735 wakeup(enc->enc_daemon);
736 } else {
737 ENC_DLOG(enc, "%s: ignoring requested action %d - "
738 "Already queued\n", __func__, action);
739 }
740}
741
742/**
743 * \brief Invoke the handler of the highest priority pending
744 * state in the SES state machine.
745 *
746 * \param enc The SES instance invoking the state machine.
747 */
748static void
749enc_fsm_step(enc_softc_t *enc)
750{
751 union ccb *ccb;
752 uint8_t *buf;
753 struct enc_fsm_state *cur_state;
754 int error;
755 uint32_t xfer_len;
756
757 ENC_DLOG(enc, "%s enter %p\n", __func__, enc);
758
759 enc->current_action = ffs(enc->pending_actions) - 1;
760 enc->pending_actions &= ~(0x1 << enc->current_action);
761
762 cur_state = &enc->enc_fsm_states[enc->current_action];
763
764 buf = NULL;
765 if (cur_state->buf_size != 0) {
766 cam_periph_unlock(enc->periph);
767 buf = malloc(cur_state->buf_size, M_SCSIENC, M_WAITOK|M_ZERO);
768 cam_periph_lock(enc->periph);
769 }
770
771 error = 0;
772 ccb = NULL;
773 if (cur_state->fill != NULL) {
774 ccb = cam_periph_getccb(enc->periph, CAM_PRIORITY_NORMAL);
775
776 error = cur_state->fill(enc, cur_state, ccb, buf);
777 if (error != 0)
778 goto done;
779
780 error = cam_periph_runccb(ccb, cur_state->error,
781 ENC_CFLAGS,
782 ENC_FLAGS|SF_QUIET_IR, NULL);
783 }
784
785 if (ccb != NULL) {
786 if (ccb->ccb_h.func_code == XPT_ATA_IO)
787 xfer_len = ccb->ataio.dxfer_len - ccb->ataio.resid;
788 else
789 xfer_len = ccb->csio.dxfer_len - ccb->csio.resid;
790 } else
791 xfer_len = 0;
792
793 cam_periph_unlock(enc->periph);
794 cur_state->done(enc, cur_state, ccb, &buf, error, xfer_len);
795 cam_periph_lock(enc->periph);
796
797done:
798 ENC_DLOG(enc, "%s exit - result %d\n", __func__, error);
799 ENC_FREE_AND_NULL(buf);
800 if (ccb != NULL)
801 xpt_release_ccb(ccb);
802}
803
804/**
805 * \invariant Called with cam_periph mutex held.
806 */
807static void
808enc_status_updater(void *arg)
809{
810 enc_softc_t *enc;
811
812 enc = arg;
813 if (enc->enc_vec.poll_status != NULL)
814 enc->enc_vec.poll_status(enc);
815}
816
817static void
818enc_daemon(void *arg)
819{
820 enc_softc_t *enc;
821
822 enc = arg;
823
824 cam_periph_lock(enc->periph);
825 while ((enc->enc_flags & ENC_FLAG_SHUTDOWN) == 0) {
826 if (enc->pending_actions == 0) {
827 struct intr_config_hook *hook;
828
829 /*
830 * Reset callout and msleep, or
831 * issue timed task completion
832 * status command.
833 */
834 enc->current_action = ENC_UPDATE_NONE;
835
836 /*
837 * We've been through our state machine at least
838 * once. Allow the transition to userland.
839 */
840 hook = &enc->enc_boot_hold_ch;
841 if (hook->ich_func != NULL) {
842 config_intrhook_disestablish(hook);
843 hook->ich_func = NULL;
844 }
845
846 callout_reset(&enc->status_updater, 60*hz,
847 enc_status_updater, enc);
848
849 cam_periph_sleep(enc->periph, enc->enc_daemon,
850 PUSER, "idle", 0);
851 } else {
852 enc_fsm_step(enc);
853 }
854 }
855 enc->enc_daemon = NULL;
856 cam_periph_unlock(enc->periph);
857 cam_periph_release(enc->periph);
858 kproc_exit(0);
859}
860
861static int
862enc_kproc_init(enc_softc_t *enc)
863{
864 int result;
865
866 callout_init_mtx(&enc->status_updater, cam_periph_mtx(enc->periph), 0);
867
868 if (cam_periph_acquire(enc->periph) != CAM_REQ_CMP)
869 return (ENXIO);
870
871 result = kproc_create(enc_daemon, enc, &enc->enc_daemon, /*flags*/0,
872 /*stackpgs*/0, "enc_daemon%d",
873 enc->periph->unit_number);
874 if (result == 0) {
875 /* Do an initial load of all page data. */
876 cam_periph_lock(enc->periph);
877 enc->enc_vec.poll_status(enc);
878 cam_periph_unlock(enc->periph);
879 } else
880 cam_periph_release(enc->periph);
881 return (result);
882}
883
884/**
885 * \brief Interrupt configuration hook callback associated with
886 * enc_boot_hold_ch.
887 *
888 * Since interrupts are always functional at the time of enclosure
889 * configuration, there is nothing to be done when the callback occurs.
890 * This hook is only registered to hold up boot processing while initial
891 * eclosure processing occurs.
892 *
893 * \param arg The enclosure softc, but currently unused in this callback.
894 */
895static void
896enc_nop_confighook_cb(void *arg __unused)
897{
898}
899
900static cam_status
901enc_ctor(struct cam_periph *periph, void *arg)
902{
903 cam_status status = CAM_REQ_CMP_ERR;
904 int err;
905 enc_softc_t *enc;
906 struct ccb_getdev *cgd;
907 char *tname;
908
909 cgd = (struct ccb_getdev *)arg;
910 if (cgd == NULL) {
911 printf("enc_ctor: no getdev CCB, can't register device\n");
912 goto out;
913 }
914
915 enc = ENC_MALLOCZ(sizeof(*enc));
916 if (enc == NULL) {
917 printf("enc_ctor: Unable to probe new device. "
918 "Unable to allocate enc\n");
919 goto out;
920 }
921 enc->periph = periph;
922 enc->current_action = ENC_UPDATE_INVALID;
923
924 enc->enc_type = enc_type(cgd);
925 sx_init(&enc->enc_cache_lock, "enccache");
926
927 switch (enc->enc_type) {
928 case ENC_SES:
929 case ENC_SES_SCSI2:
930 case ENC_SES_PASSTHROUGH:
931 case ENC_SEMB_SES:
932 err = ses_softc_init(enc);
933 break;
934 case ENC_SAFT:
935 case ENC_SEMB_SAFT:
936 err = safte_softc_init(enc);
937 break;
938 case ENC_NONE:
939 default:
940 ENC_FREE(enc);
941 return (CAM_REQ_CMP_ERR);
942 }
943
944 if (err) {
945 xpt_print(periph->path, "error %d initializing\n", err);
946 goto out;
947 }
948
949 /*
950 * Hold off userland until we have made at least one pass
951 * through our state machine so that physical path data is
952 * present.
953 */
954 if (enc->enc_vec.poll_status != NULL) {
955 enc->enc_boot_hold_ch.ich_func = enc_nop_confighook_cb;
956 enc->enc_boot_hold_ch.ich_arg = enc;
957 config_intrhook_establish(&enc->enc_boot_hold_ch);
958 }
959
960 /*
961 * The softc field is set only once the enc is fully initialized
962 * so that we can rely on this field to detect partially
963 * initialized periph objects in the AC_FOUND_DEVICE handler.
964 */
965 periph->softc = enc;
966
967 cam_periph_unlock(periph);
968 if (enc->enc_vec.poll_status != NULL) {
969 err = enc_kproc_init(enc);
970 if (err) {
971 xpt_print(periph->path,
972 "error %d starting enc_daemon\n", err);
973 goto out;
974 }
975 }
976
977 /*
978 * Acquire a reference to the periph before we create the devfs
979 * instance for it. We'll release this reference once the devfs
980 * instance has been freed.
981 */
982 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
983 xpt_print(periph->path, "%s: lost periph during "
984 "registration!\n", __func__);
985 cam_periph_lock(periph);
986
987 return (CAM_REQ_CMP_ERR);
988 }
989
990 enc->enc_dev = make_dev(&enc_cdevsw, periph->unit_number,
991 UID_ROOT, GID_OPERATOR, 0600, "%s%d",
992 periph->periph_name, periph->unit_number);
993
994 cam_periph_lock(periph);
995 enc->enc_dev->si_drv1 = periph;
996
997 enc->enc_flags |= ENC_FLAG_INITIALIZED;
998
999 /*
1000 * Add an async callback so that we get notified if this
1001 * device goes away.
1002 */
1003 xpt_register_async(AC_LOST_DEVICE, enc_async, periph, periph->path);
1004
1005 switch (enc->enc_type) {
1006 default:
1007 case ENC_NONE:
1008 tname = "No ENC device";
1009 break;
1010 case ENC_SES_SCSI2:
1011 tname = "SCSI-2 ENC Device";
1012 break;
1013 case ENC_SES:
1014 tname = "SCSI-3 ENC Device";
1015 break;
1016 case ENC_SES_PASSTHROUGH:
1017 tname = "ENC Passthrough Device";
1018 break;
1019 case ENC_SAFT:
1020 tname = "SAF-TE Compliant Device";
1021 break;
1022 case ENC_SEMB_SES:
1023 tname = "SEMB SES Device";
1024 break;
1025 case ENC_SEMB_SAFT:
1026 tname = "SEMB SAF-TE Device";
1027 break;
1028 }
1029 xpt_announce_periph(periph, tname);
1030 status = CAM_REQ_CMP;
1031
1032out:
1033 if (status != CAM_REQ_CMP)
1034 enc_dtor(periph);
1035 return (status);
1036}
1037
2 * Copyright (c) 2000 Matthew Jacob
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. The name of the author may not be used to endorse or promote products
12 * derived from this software without specific prior written permission.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: head/sys/cam/scsi/scsi_enc.c 291126 2015-11-21 10:22:01Z mav $");
29
30#include <sys/param.h>
31
32#include <sys/conf.h>
33#include <sys/errno.h>
34#include <sys/fcntl.h>
35#include <sys/kernel.h>
36#include <sys/kthread.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/queue.h>
41#include <sys/sx.h>
42#include <sys/systm.h>
43#include <sys/sysctl.h>
44#include <sys/types.h>
45
46#include <machine/stdarg.h>
47
48#include <cam/cam.h>
49#include <cam/cam_ccb.h>
50#include <cam/cam_debug.h>
51#include <cam/cam_periph.h>
52#include <cam/cam_xpt_periph.h>
53
54#include <cam/scsi/scsi_all.h>
55#include <cam/scsi/scsi_message.h>
56#include <cam/scsi/scsi_enc.h>
57#include <cam/scsi/scsi_enc_internal.h>
58
59#include <opt_ses.h>
60
61MALLOC_DEFINE(M_SCSIENC, "SCSI ENC", "SCSI ENC buffers");
62
63/* Enclosure type independent driver */
64
65static d_open_t enc_open;
66static d_close_t enc_close;
67static d_ioctl_t enc_ioctl;
68static periph_init_t enc_init;
69static periph_ctor_t enc_ctor;
70static periph_oninv_t enc_oninvalidate;
71static periph_dtor_t enc_dtor;
72
73static void enc_async(void *, uint32_t, struct cam_path *, void *);
74static enctyp enc_type(struct ccb_getdev *);
75
76SYSCTL_NODE(_kern_cam, OID_AUTO, enc, CTLFLAG_RD, 0,
77 "CAM Enclosure Services driver");
78
79static struct periph_driver encdriver = {
80 enc_init, "ses",
81 TAILQ_HEAD_INITIALIZER(encdriver.units), /* generation */ 0
82};
83
84PERIPHDRIVER_DECLARE(enc, encdriver);
85
86static struct cdevsw enc_cdevsw = {
87 .d_version = D_VERSION,
88 .d_open = enc_open,
89 .d_close = enc_close,
90 .d_ioctl = enc_ioctl,
91 .d_name = "ses",
92 .d_flags = D_TRACKCLOSE,
93};
94
95static void
96enc_init(void)
97{
98 cam_status status;
99
100 /*
101 * Install a global async callback. This callback will
102 * receive async callbacks like "new device found".
103 */
104 status = xpt_register_async(AC_FOUND_DEVICE, enc_async, NULL, NULL);
105
106 if (status != CAM_REQ_CMP) {
107 printf("enc: Failed to attach master async callback "
108 "due to status 0x%x!\n", status);
109 }
110}
111
112static void
113enc_devgonecb(void *arg)
114{
115 struct cam_periph *periph;
116 struct enc_softc *enc;
117 struct mtx *mtx;
118 int i;
119
120 periph = (struct cam_periph *)arg;
121 mtx = cam_periph_mtx(periph);
122 mtx_lock(mtx);
123 enc = (struct enc_softc *)periph->softc;
124
125 /*
126 * When we get this callback, we will get no more close calls from
127 * devfs. So if we have any dangling opens, we need to release the
128 * reference held for that particular context.
129 */
130 for (i = 0; i < enc->open_count; i++)
131 cam_periph_release_locked(periph);
132
133 enc->open_count = 0;
134
135 /*
136 * Release the reference held for the device node, it is gone now.
137 */
138 cam_periph_release_locked(periph);
139
140 /*
141 * We reference the lock directly here, instead of using
142 * cam_periph_unlock(). The reason is that the final call to
143 * cam_periph_release_locked() above could result in the periph
144 * getting freed. If that is the case, dereferencing the periph
145 * with a cam_periph_unlock() call would cause a page fault.
146 */
147 mtx_unlock(mtx);
148}
149
150static void
151enc_oninvalidate(struct cam_periph *periph)
152{
153 struct enc_softc *enc;
154
155 enc = periph->softc;
156
157 enc->enc_flags |= ENC_FLAG_INVALID;
158
159 /* If the sub-driver has an invalidate routine, call it */
160 if (enc->enc_vec.softc_invalidate != NULL)
161 enc->enc_vec.softc_invalidate(enc);
162
163 /*
164 * Unregister any async callbacks.
165 */
166 xpt_register_async(0, enc_async, periph, periph->path);
167
168 /*
169 * Shutdown our daemon.
170 */
171 enc->enc_flags |= ENC_FLAG_SHUTDOWN;
172 if (enc->enc_daemon != NULL) {
173 /* Signal the ses daemon to terminate. */
174 wakeup(enc->enc_daemon);
175 }
176 callout_drain(&enc->status_updater);
177
178 destroy_dev_sched_cb(enc->enc_dev, enc_devgonecb, periph);
179}
180
181static void
182enc_dtor(struct cam_periph *periph)
183{
184 struct enc_softc *enc;
185
186 enc = periph->softc;
187
188 /* If the sub-driver has a cleanup routine, call it */
189 if (enc->enc_vec.softc_cleanup != NULL)
190 enc->enc_vec.softc_cleanup(enc);
191
192 if (enc->enc_boot_hold_ch.ich_func != NULL) {
193 config_intrhook_disestablish(&enc->enc_boot_hold_ch);
194 enc->enc_boot_hold_ch.ich_func = NULL;
195 }
196
197 ENC_FREE(enc);
198}
199
200static void
201enc_async(void *callback_arg, uint32_t code, struct cam_path *path, void *arg)
202{
203 struct cam_periph *periph;
204
205 periph = (struct cam_periph *)callback_arg;
206
207 switch(code) {
208 case AC_FOUND_DEVICE:
209 {
210 struct ccb_getdev *cgd;
211 cam_status status;
212 path_id_t path_id;
213
214 cgd = (struct ccb_getdev *)arg;
215 if (arg == NULL) {
216 break;
217 }
218
219 if (enc_type(cgd) == ENC_NONE) {
220 /*
221 * Schedule announcement of the ENC bindings for
222 * this device if it is managed by a SEP.
223 */
224 path_id = xpt_path_path_id(path);
225 xpt_lock_buses();
226 TAILQ_FOREACH(periph, &encdriver.units, unit_links) {
227 struct enc_softc *softc;
228
229 softc = (struct enc_softc *)periph->softc;
230 if (xpt_path_path_id(periph->path) != path_id
231 || softc == NULL
232 || (softc->enc_flags & ENC_FLAG_INITIALIZED)
233 == 0
234 || softc->enc_vec.device_found == NULL)
235 continue;
236
237 softc->enc_vec.device_found(softc);
238 }
239 xpt_unlock_buses();
240 return;
241 }
242
243 status = cam_periph_alloc(enc_ctor, enc_oninvalidate,
244 enc_dtor, NULL, "ses", CAM_PERIPH_BIO,
245 path, enc_async, AC_FOUND_DEVICE, cgd);
246
247 if (status != CAM_REQ_CMP && status != CAM_REQ_INPROG) {
248 printf("enc_async: Unable to probe new device due to "
249 "status 0x%x\n", status);
250 }
251 break;
252 }
253 default:
254 cam_periph_async(periph, code, path, arg);
255 break;
256 }
257}
258
259static int
260enc_open(struct cdev *dev, int flags, int fmt, struct thread *td)
261{
262 struct cam_periph *periph;
263 struct enc_softc *softc;
264 int error = 0;
265
266 periph = (struct cam_periph *)dev->si_drv1;
267 if (periph == NULL) {
268 return (ENXIO);
269 }
270
271 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
272 return (ENXIO);
273
274 cam_periph_lock(periph);
275
276 softc = (struct enc_softc *)periph->softc;
277
278 if ((softc->enc_flags & ENC_FLAG_INITIALIZED) == 0) {
279 error = ENXIO;
280 goto out;
281 }
282 if (softc->enc_flags & ENC_FLAG_INVALID) {
283 error = ENXIO;
284 goto out;
285 }
286out:
287 if (error != 0)
288 cam_periph_release_locked(periph);
289 else
290 softc->open_count++;
291
292 cam_periph_unlock(periph);
293
294 return (error);
295}
296
297static int
298enc_close(struct cdev *dev, int flag, int fmt, struct thread *td)
299{
300 struct cam_periph *periph;
301 struct enc_softc *enc;
302 struct mtx *mtx;
303
304 periph = (struct cam_periph *)dev->si_drv1;
305 if (periph == NULL)
306 return (ENXIO);
307 mtx = cam_periph_mtx(periph);
308 mtx_lock(mtx);
309
310 enc = periph->softc;
311 enc->open_count--;
312
313 cam_periph_release_locked(periph);
314
315 /*
316 * We reference the lock directly here, instead of using
317 * cam_periph_unlock(). The reason is that the call to
318 * cam_periph_release_locked() above could result in the periph
319 * getting freed. If that is the case, dereferencing the periph
320 * with a cam_periph_unlock() call would cause a page fault.
321 *
322 * cam_periph_release() avoids this problem using the same method,
323 * but we're manually acquiring and dropping the lock here to
324 * protect the open count and avoid another lock acquisition and
325 * release.
326 */
327 mtx_unlock(mtx);
328
329 return (0);
330}
331
332int
333enc_error(union ccb *ccb, uint32_t cflags, uint32_t sflags)
334{
335 struct enc_softc *softc;
336 struct cam_periph *periph;
337
338 periph = xpt_path_periph(ccb->ccb_h.path);
339 softc = (struct enc_softc *)periph->softc;
340
341 return (cam_periph_error(ccb, cflags, sflags, &softc->saved_ccb));
342}
343
344static int
345enc_ioctl(struct cdev *dev, u_long cmd, caddr_t arg_addr, int flag,
346 struct thread *td)
347{
348 struct cam_periph *periph;
349 encioc_enc_status_t tmp;
350 encioc_string_t sstr;
351 encioc_elm_status_t elms;
352 encioc_elm_desc_t elmd;
353 encioc_elm_devnames_t elmdn;
354 encioc_element_t *uelm;
355 enc_softc_t *enc;
356 enc_cache_t *cache;
357 void *addr;
358 int error, i;
359
360
361 if (arg_addr)
362 addr = *((caddr_t *) arg_addr);
363 else
364 addr = NULL;
365
366 periph = (struct cam_periph *)dev->si_drv1;
367 if (periph == NULL)
368 return (ENXIO);
369
370 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering encioctl\n"));
371
372 cam_periph_lock(periph);
373 enc = (struct enc_softc *)periph->softc;
374 cache = &enc->enc_cache;
375
376 /*
377 * Now check to see whether we're initialized or not.
378 * This actually should never fail as we're not supposed
379 * to get past enc_open w/o successfully initializing
380 * things.
381 */
382 if ((enc->enc_flags & ENC_FLAG_INITIALIZED) == 0) {
383 cam_periph_unlock(periph);
384 return (ENXIO);
385 }
386 cam_periph_unlock(periph);
387
388 error = 0;
389
390 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
391 ("trying to do ioctl %#lx\n", cmd));
392
393 /*
394 * If this command can change the device's state,
395 * we must have the device open for writing.
396 *
397 * For commands that get information about the
398 * device- we don't need to lock the peripheral
399 * if we aren't running a command. The periph
400 * also can't go away while a user process has
401 * it open.
402 */
403 switch (cmd) {
404 case ENCIOC_GETNELM:
405 case ENCIOC_GETELMMAP:
406 case ENCIOC_GETENCSTAT:
407 case ENCIOC_GETELMSTAT:
408 case ENCIOC_GETELMDESC:
409 case ENCIOC_GETELMDEVNAMES:
410 case ENCIOC_GETENCNAME:
411 case ENCIOC_GETENCID:
412 break;
413 default:
414 if ((flag & FWRITE) == 0) {
415 return (EBADF);
416 }
417 }
418
419 /*
420 * XXX The values read here are only valid for the current
421 * configuration generation. We need these ioctls
422 * to also pass in/out a generation number.
423 */
424 sx_slock(&enc->enc_cache_lock);
425 switch (cmd) {
426 case ENCIOC_GETNELM:
427 error = copyout(&cache->nelms, addr, sizeof (cache->nelms));
428 break;
429
430 case ENCIOC_GETELMMAP:
431 for (uelm = addr, i = 0; i != cache->nelms; i++) {
432 encioc_element_t kelm;
433 kelm.elm_idx = i;
434 kelm.elm_subenc_id = cache->elm_map[i].subenclosure;
435 kelm.elm_type = cache->elm_map[i].enctype;
436 error = copyout(&kelm, &uelm[i], sizeof(kelm));
437 if (error)
438 break;
439 }
440 break;
441
442 case ENCIOC_GETENCSTAT:
443 cam_periph_lock(periph);
444 error = enc->enc_vec.get_enc_status(enc, 1);
445 if (error) {
446 cam_periph_unlock(periph);
447 break;
448 }
449 tmp = cache->enc_status;
450 cam_periph_unlock(periph);
451 error = copyout(&tmp, addr, sizeof(tmp));
452 cache->enc_status = tmp;
453 break;
454
455 case ENCIOC_SETENCSTAT:
456 error = copyin(addr, &tmp, sizeof(tmp));
457 if (error)
458 break;
459 cam_periph_lock(periph);
460 error = enc->enc_vec.set_enc_status(enc, tmp, 1);
461 cam_periph_unlock(periph);
462 break;
463
464 case ENCIOC_GETSTRING:
465 case ENCIOC_SETSTRING:
466 case ENCIOC_GETENCNAME:
467 case ENCIOC_GETENCID:
468 if (enc->enc_vec.handle_string == NULL) {
469 error = EINVAL;
470 break;
471 }
472 error = copyin(addr, &sstr, sizeof(sstr));
473 if (error)
474 break;
475 cam_periph_lock(periph);
476 error = enc->enc_vec.handle_string(enc, &sstr, cmd);
477 cam_periph_unlock(periph);
478 break;
479
480 case ENCIOC_GETELMSTAT:
481 error = copyin(addr, &elms, sizeof(elms));
482 if (error)
483 break;
484 if (elms.elm_idx >= cache->nelms) {
485 error = EINVAL;
486 break;
487 }
488 cam_periph_lock(periph);
489 error = enc->enc_vec.get_elm_status(enc, &elms, 1);
490 cam_periph_unlock(periph);
491 if (error)
492 break;
493 error = copyout(&elms, addr, sizeof(elms));
494 break;
495
496 case ENCIOC_GETELMDESC:
497 error = copyin(addr, &elmd, sizeof(elmd));
498 if (error)
499 break;
500 if (elmd.elm_idx >= cache->nelms) {
501 error = EINVAL;
502 break;
503 }
504 if (enc->enc_vec.get_elm_desc != NULL) {
505 error = enc->enc_vec.get_elm_desc(enc, &elmd);
506 if (error)
507 break;
508 } else
509 elmd.elm_desc_len = 0;
510 error = copyout(&elmd, addr, sizeof(elmd));
511 break;
512
513 case ENCIOC_GETELMDEVNAMES:
514 if (enc->enc_vec.get_elm_devnames == NULL) {
515 error = EINVAL;
516 break;
517 }
518 error = copyin(addr, &elmdn, sizeof(elmdn));
519 if (error)
520 break;
521 if (elmdn.elm_idx >= cache->nelms) {
522 error = EINVAL;
523 break;
524 }
525 cam_periph_lock(periph);
526 error = (*enc->enc_vec.get_elm_devnames)(enc, &elmdn);
527 cam_periph_unlock(periph);
528 if (error)
529 break;
530 error = copyout(&elmdn, addr, sizeof(elmdn));
531 break;
532
533 case ENCIOC_SETELMSTAT:
534 error = copyin(addr, &elms, sizeof(elms));
535 if (error)
536 break;
537
538 if (elms.elm_idx >= cache->nelms) {
539 error = EINVAL;
540 break;
541 }
542 cam_periph_lock(periph);
543 error = enc->enc_vec.set_elm_status(enc, &elms, 1);
544 cam_periph_unlock(periph);
545
546 break;
547
548 case ENCIOC_INIT:
549
550 cam_periph_lock(periph);
551 error = enc->enc_vec.init_enc(enc);
552 cam_periph_unlock(periph);
553 break;
554
555 default:
556 cam_periph_lock(periph);
557 error = cam_periph_ioctl(periph, cmd, arg_addr, enc_error);
558 cam_periph_unlock(periph);
559 break;
560 }
561 sx_sunlock(&enc->enc_cache_lock);
562 return (error);
563}
564
565int
566enc_runcmd(struct enc_softc *enc, char *cdb, int cdbl, char *dptr, int *dlenp)
567{
568 int error, dlen, tdlen;
569 ccb_flags ddf;
570 union ccb *ccb;
571
572 CAM_DEBUG(enc->periph->path, CAM_DEBUG_TRACE,
573 ("entering enc_runcmd\n"));
574 if (dptr) {
575 if ((dlen = *dlenp) < 0) {
576 dlen = -dlen;
577 ddf = CAM_DIR_OUT;
578 } else {
579 ddf = CAM_DIR_IN;
580 }
581 } else {
582 dlen = 0;
583 ddf = CAM_DIR_NONE;
584 }
585
586 if (cdbl > IOCDBLEN) {
587 cdbl = IOCDBLEN;
588 }
589
590 ccb = cam_periph_getccb(enc->periph, CAM_PRIORITY_NORMAL);
591 if (enc->enc_type == ENC_SEMB_SES || enc->enc_type == ENC_SEMB_SAFT) {
592 tdlen = min(dlen, 1020);
593 tdlen = (tdlen + 3) & ~3;
594 cam_fill_ataio(&ccb->ataio, 0, NULL, ddf, 0, dptr, tdlen,
595 30 * 1000);
596 if (cdb[0] == RECEIVE_DIAGNOSTIC)
597 ata_28bit_cmd(&ccb->ataio,
598 ATA_SEP_ATTN, cdb[2], 0x02, tdlen / 4);
599 else if (cdb[0] == SEND_DIAGNOSTIC)
600 ata_28bit_cmd(&ccb->ataio,
601 ATA_SEP_ATTN, dlen > 0 ? dptr[0] : 0,
602 0x82, tdlen / 4);
603 else if (cdb[0] == READ_BUFFER)
604 ata_28bit_cmd(&ccb->ataio,
605 ATA_SEP_ATTN, cdb[2], 0x00, tdlen / 4);
606 else
607 ata_28bit_cmd(&ccb->ataio,
608 ATA_SEP_ATTN, dlen > 0 ? dptr[0] : 0,
609 0x80, tdlen / 4);
610 } else {
611 tdlen = dlen;
612 cam_fill_csio(&ccb->csio, 0, NULL, ddf, MSG_SIMPLE_Q_TAG,
613 dptr, dlen, sizeof (struct scsi_sense_data), cdbl,
614 60 * 1000);
615 bcopy(cdb, ccb->csio.cdb_io.cdb_bytes, cdbl);
616 }
617
618 error = cam_periph_runccb(ccb, enc_error, ENC_CFLAGS, ENC_FLAGS, NULL);
619 if (error) {
620 if (dptr) {
621 *dlenp = dlen;
622 }
623 } else {
624 if (dptr) {
625 if (ccb->ccb_h.func_code == XPT_ATA_IO)
626 *dlenp = ccb->ataio.resid;
627 else
628 *dlenp = ccb->csio.resid;
629 *dlenp += tdlen - dlen;
630 }
631 }
632 xpt_release_ccb(ccb);
633 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE,
634 ("exiting enc_runcmd: *dlenp = %d\n", *dlenp));
635 return (error);
636}
637
638void
639enc_log(struct enc_softc *enc, const char *fmt, ...)
640{
641 va_list ap;
642
643 printf("%s%d: ", enc->periph->periph_name, enc->periph->unit_number);
644 va_start(ap, fmt);
645 vprintf(fmt, ap);
646 va_end(ap);
647}
648
649/*
650 * The code after this point runs on many platforms,
651 * so forgive the slightly awkward and nonconforming
652 * appearance.
653 */
654
655/*
656 * Is this a device that supports enclosure services?
657 *
658 * It's a pretty simple ruleset- if it is device type
659 * 0x0D (13), it's an ENCLOSURE device.
660 */
661
662#define SAFTE_START 44
663#define SAFTE_END 50
664#define SAFTE_LEN SAFTE_END-SAFTE_START
665
666static enctyp
667enc_type(struct ccb_getdev *cgd)
668{
669 int buflen;
670 unsigned char *iqd;
671
672 if (cgd->protocol == PROTO_SEMB) {
673 iqd = (unsigned char *)&cgd->ident_data;
674 if (STRNCMP(iqd + 43, "S-E-S", 5) == 0)
675 return (ENC_SEMB_SES);
676 else if (STRNCMP(iqd + 43, "SAF-TE", 6) == 0)
677 return (ENC_SEMB_SAFT);
678 return (ENC_NONE);
679
680 } else if (cgd->protocol != PROTO_SCSI)
681 return (ENC_NONE);
682
683 iqd = (unsigned char *)&cgd->inq_data;
684 buflen = min(sizeof(cgd->inq_data),
685 SID_ADDITIONAL_LENGTH(&cgd->inq_data));
686
687 if ((iqd[0] & 0x1f) == T_ENCLOSURE) {
688 if ((iqd[2] & 0x7) > 2) {
689 return (ENC_SES);
690 } else {
691 return (ENC_SES_SCSI2);
692 }
693 return (ENC_NONE);
694 }
695
696#ifdef SES_ENABLE_PASSTHROUGH
697 if ((iqd[6] & 0x40) && (iqd[2] & 0x7) >= 2) {
698 /*
699 * PassThrough Device.
700 */
701 return (ENC_SES_PASSTHROUGH);
702 }
703#endif
704
705 /*
706 * The comparison is short for a reason-
707 * some vendors were chopping it short.
708 */
709
710 if (buflen < SAFTE_END - 2) {
711 return (ENC_NONE);
712 }
713
714 if (STRNCMP((char *)&iqd[SAFTE_START], "SAF-TE", SAFTE_LEN - 2) == 0) {
715 return (ENC_SAFT);
716 }
717 return (ENC_NONE);
718}
719
720/*================== Enclosure Monitoring/Processing Daemon ==================*/
721/**
722 * \brief Queue an update request for a given action, if needed.
723 *
724 * \param enc SES softc to queue the request for.
725 * \param action Action requested.
726 */
727void
728enc_update_request(enc_softc_t *enc, uint32_t action)
729{
730 if ((enc->pending_actions & (0x1 << action)) == 0) {
731 enc->pending_actions |= (0x1 << action);
732 ENC_DLOG(enc, "%s: queing requested action %d\n",
733 __func__, action);
734 if (enc->current_action == ENC_UPDATE_NONE)
735 wakeup(enc->enc_daemon);
736 } else {
737 ENC_DLOG(enc, "%s: ignoring requested action %d - "
738 "Already queued\n", __func__, action);
739 }
740}
741
742/**
743 * \brief Invoke the handler of the highest priority pending
744 * state in the SES state machine.
745 *
746 * \param enc The SES instance invoking the state machine.
747 */
748static void
749enc_fsm_step(enc_softc_t *enc)
750{
751 union ccb *ccb;
752 uint8_t *buf;
753 struct enc_fsm_state *cur_state;
754 int error;
755 uint32_t xfer_len;
756
757 ENC_DLOG(enc, "%s enter %p\n", __func__, enc);
758
759 enc->current_action = ffs(enc->pending_actions) - 1;
760 enc->pending_actions &= ~(0x1 << enc->current_action);
761
762 cur_state = &enc->enc_fsm_states[enc->current_action];
763
764 buf = NULL;
765 if (cur_state->buf_size != 0) {
766 cam_periph_unlock(enc->periph);
767 buf = malloc(cur_state->buf_size, M_SCSIENC, M_WAITOK|M_ZERO);
768 cam_periph_lock(enc->periph);
769 }
770
771 error = 0;
772 ccb = NULL;
773 if (cur_state->fill != NULL) {
774 ccb = cam_periph_getccb(enc->periph, CAM_PRIORITY_NORMAL);
775
776 error = cur_state->fill(enc, cur_state, ccb, buf);
777 if (error != 0)
778 goto done;
779
780 error = cam_periph_runccb(ccb, cur_state->error,
781 ENC_CFLAGS,
782 ENC_FLAGS|SF_QUIET_IR, NULL);
783 }
784
785 if (ccb != NULL) {
786 if (ccb->ccb_h.func_code == XPT_ATA_IO)
787 xfer_len = ccb->ataio.dxfer_len - ccb->ataio.resid;
788 else
789 xfer_len = ccb->csio.dxfer_len - ccb->csio.resid;
790 } else
791 xfer_len = 0;
792
793 cam_periph_unlock(enc->periph);
794 cur_state->done(enc, cur_state, ccb, &buf, error, xfer_len);
795 cam_periph_lock(enc->periph);
796
797done:
798 ENC_DLOG(enc, "%s exit - result %d\n", __func__, error);
799 ENC_FREE_AND_NULL(buf);
800 if (ccb != NULL)
801 xpt_release_ccb(ccb);
802}
803
804/**
805 * \invariant Called with cam_periph mutex held.
806 */
807static void
808enc_status_updater(void *arg)
809{
810 enc_softc_t *enc;
811
812 enc = arg;
813 if (enc->enc_vec.poll_status != NULL)
814 enc->enc_vec.poll_status(enc);
815}
816
817static void
818enc_daemon(void *arg)
819{
820 enc_softc_t *enc;
821
822 enc = arg;
823
824 cam_periph_lock(enc->periph);
825 while ((enc->enc_flags & ENC_FLAG_SHUTDOWN) == 0) {
826 if (enc->pending_actions == 0) {
827 struct intr_config_hook *hook;
828
829 /*
830 * Reset callout and msleep, or
831 * issue timed task completion
832 * status command.
833 */
834 enc->current_action = ENC_UPDATE_NONE;
835
836 /*
837 * We've been through our state machine at least
838 * once. Allow the transition to userland.
839 */
840 hook = &enc->enc_boot_hold_ch;
841 if (hook->ich_func != NULL) {
842 config_intrhook_disestablish(hook);
843 hook->ich_func = NULL;
844 }
845
846 callout_reset(&enc->status_updater, 60*hz,
847 enc_status_updater, enc);
848
849 cam_periph_sleep(enc->periph, enc->enc_daemon,
850 PUSER, "idle", 0);
851 } else {
852 enc_fsm_step(enc);
853 }
854 }
855 enc->enc_daemon = NULL;
856 cam_periph_unlock(enc->periph);
857 cam_periph_release(enc->periph);
858 kproc_exit(0);
859}
860
861static int
862enc_kproc_init(enc_softc_t *enc)
863{
864 int result;
865
866 callout_init_mtx(&enc->status_updater, cam_periph_mtx(enc->periph), 0);
867
868 if (cam_periph_acquire(enc->periph) != CAM_REQ_CMP)
869 return (ENXIO);
870
871 result = kproc_create(enc_daemon, enc, &enc->enc_daemon, /*flags*/0,
872 /*stackpgs*/0, "enc_daemon%d",
873 enc->periph->unit_number);
874 if (result == 0) {
875 /* Do an initial load of all page data. */
876 cam_periph_lock(enc->periph);
877 enc->enc_vec.poll_status(enc);
878 cam_periph_unlock(enc->periph);
879 } else
880 cam_periph_release(enc->periph);
881 return (result);
882}
883
884/**
885 * \brief Interrupt configuration hook callback associated with
886 * enc_boot_hold_ch.
887 *
888 * Since interrupts are always functional at the time of enclosure
889 * configuration, there is nothing to be done when the callback occurs.
890 * This hook is only registered to hold up boot processing while initial
891 * eclosure processing occurs.
892 *
893 * \param arg The enclosure softc, but currently unused in this callback.
894 */
895static void
896enc_nop_confighook_cb(void *arg __unused)
897{
898}
899
900static cam_status
901enc_ctor(struct cam_periph *periph, void *arg)
902{
903 cam_status status = CAM_REQ_CMP_ERR;
904 int err;
905 enc_softc_t *enc;
906 struct ccb_getdev *cgd;
907 char *tname;
908
909 cgd = (struct ccb_getdev *)arg;
910 if (cgd == NULL) {
911 printf("enc_ctor: no getdev CCB, can't register device\n");
912 goto out;
913 }
914
915 enc = ENC_MALLOCZ(sizeof(*enc));
916 if (enc == NULL) {
917 printf("enc_ctor: Unable to probe new device. "
918 "Unable to allocate enc\n");
919 goto out;
920 }
921 enc->periph = periph;
922 enc->current_action = ENC_UPDATE_INVALID;
923
924 enc->enc_type = enc_type(cgd);
925 sx_init(&enc->enc_cache_lock, "enccache");
926
927 switch (enc->enc_type) {
928 case ENC_SES:
929 case ENC_SES_SCSI2:
930 case ENC_SES_PASSTHROUGH:
931 case ENC_SEMB_SES:
932 err = ses_softc_init(enc);
933 break;
934 case ENC_SAFT:
935 case ENC_SEMB_SAFT:
936 err = safte_softc_init(enc);
937 break;
938 case ENC_NONE:
939 default:
940 ENC_FREE(enc);
941 return (CAM_REQ_CMP_ERR);
942 }
943
944 if (err) {
945 xpt_print(periph->path, "error %d initializing\n", err);
946 goto out;
947 }
948
949 /*
950 * Hold off userland until we have made at least one pass
951 * through our state machine so that physical path data is
952 * present.
953 */
954 if (enc->enc_vec.poll_status != NULL) {
955 enc->enc_boot_hold_ch.ich_func = enc_nop_confighook_cb;
956 enc->enc_boot_hold_ch.ich_arg = enc;
957 config_intrhook_establish(&enc->enc_boot_hold_ch);
958 }
959
960 /*
961 * The softc field is set only once the enc is fully initialized
962 * so that we can rely on this field to detect partially
963 * initialized periph objects in the AC_FOUND_DEVICE handler.
964 */
965 periph->softc = enc;
966
967 cam_periph_unlock(periph);
968 if (enc->enc_vec.poll_status != NULL) {
969 err = enc_kproc_init(enc);
970 if (err) {
971 xpt_print(periph->path,
972 "error %d starting enc_daemon\n", err);
973 goto out;
974 }
975 }
976
977 /*
978 * Acquire a reference to the periph before we create the devfs
979 * instance for it. We'll release this reference once the devfs
980 * instance has been freed.
981 */
982 if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
983 xpt_print(periph->path, "%s: lost periph during "
984 "registration!\n", __func__);
985 cam_periph_lock(periph);
986
987 return (CAM_REQ_CMP_ERR);
988 }
989
990 enc->enc_dev = make_dev(&enc_cdevsw, periph->unit_number,
991 UID_ROOT, GID_OPERATOR, 0600, "%s%d",
992 periph->periph_name, periph->unit_number);
993
994 cam_periph_lock(periph);
995 enc->enc_dev->si_drv1 = periph;
996
997 enc->enc_flags |= ENC_FLAG_INITIALIZED;
998
999 /*
1000 * Add an async callback so that we get notified if this
1001 * device goes away.
1002 */
1003 xpt_register_async(AC_LOST_DEVICE, enc_async, periph, periph->path);
1004
1005 switch (enc->enc_type) {
1006 default:
1007 case ENC_NONE:
1008 tname = "No ENC device";
1009 break;
1010 case ENC_SES_SCSI2:
1011 tname = "SCSI-2 ENC Device";
1012 break;
1013 case ENC_SES:
1014 tname = "SCSI-3 ENC Device";
1015 break;
1016 case ENC_SES_PASSTHROUGH:
1017 tname = "ENC Passthrough Device";
1018 break;
1019 case ENC_SAFT:
1020 tname = "SAF-TE Compliant Device";
1021 break;
1022 case ENC_SEMB_SES:
1023 tname = "SEMB SES Device";
1024 break;
1025 case ENC_SEMB_SAFT:
1026 tname = "SEMB SAF-TE Device";
1027 break;
1028 }
1029 xpt_announce_periph(periph, tname);
1030 status = CAM_REQ_CMP;
1031
1032out:
1033 if (status != CAM_REQ_CMP)
1034 enc_dtor(periph);
1035 return (status);
1036}
1037