2 * Copyright (c) 2000 Matthew Jacob
3 * Copyright (c) 2010 Spectra Logic Corporation
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions, and the following disclaimer,
11 * without modification, immediately at the beginning of the file.
12 * 2. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
19 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * \file scsi_enc_ses.c
31 * Structures and routines specific && private to SES only
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
39 #include <sys/ctype.h>
40 #include <sys/errno.h>
41 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/mutex.h>
45 #include <sys/queue.h>
48 #include <sys/systm.h>
49 #include <sys/types.h>
52 #include <cam/cam_ccb.h>
53 #include <cam/cam_xpt_periph.h>
54 #include <cam/cam_periph.h>
56 #include <cam/scsi/scsi_message.h>
57 #include <cam/scsi/scsi_enc.h>
58 #include <cam/scsi/scsi_enc_internal.h>
60 /* SES Native Type Device Support */
62 /* SES Diagnostic Page Codes */
64 SesSupportedPages = 0x0,
67 SesStatusPage = SesControlPage,
70 SesStringIn = SesStringOut,
71 SesThresholdOut = 0x5,
72 SesThresholdIn = SesThresholdOut,
73 SesArrayControl = 0x6, /* Obsolete in SES v2 */
74 SesArrayStatus = SesArrayControl,
75 SesElementDescriptor = 0x7,
77 SesEnclosureBusy = 0x9,
78 SesAddlElementStatus = 0xa
81 typedef struct ses_type {
82 const struct ses_elm_type_desc *hdr;
86 typedef struct ses_comstat {
91 typedef union ses_addl_data {
92 struct ses_elm_sas_device_phy *sasdev_phys;
93 struct ses_elm_sas_expander_phy *sasexp_phys;
94 struct ses_elm_sas_port_phy *sasport_phys;
95 struct ses_fcobj_port *fc_ports;
98 typedef struct ses_addl_status {
99 struct ses_elm_addlstatus_base_hdr *hdr;
101 union ses_fcobj_hdr *fc;
102 union ses_elm_sas_hdr *sas;
104 union ses_addl_data proto_data; /* array sizes stored in header */
107 typedef struct ses_element {
108 uint8_t eip; /* eip bit is set */
109 uint16_t descr_len; /* length of the descriptor */
110 char *descr; /* descriptor for this object */
111 struct ses_addl_status addl; /* additional status info */
114 typedef struct ses_control_request {
116 ses_comstat_t elm_stat;
118 TAILQ_ENTRY(ses_control_request) links;
119 } ses_control_request_t;
120 TAILQ_HEAD(ses_control_reqlist, ses_control_request);
121 typedef struct ses_control_reqlist ses_control_reqlist_t;
123 SES_SETSTATUS_ENC_IDX = -1
127 ses_terminate_control_requests(ses_control_reqlist_t *reqlist, int result)
129 ses_control_request_t *req;
131 while ((req = TAILQ_FIRST(reqlist)) != NULL) {
132 TAILQ_REMOVE(reqlist, req, links);
133 req->result = result;
138 enum ses_iter_index_values {
140 * \brief Value of an initialized but invalid index
141 * in a ses_iterator object.
143 * This value is used for the individual_element_index of
144 * overal status elements and for all index types when
145 * an iterator is first initialized.
147 ITERATOR_INDEX_INVALID = -1,
150 * \brief Value of an index in a ses_iterator object
151 * when the iterator has traversed past the last
154 ITERATOR_INDEX_END = INT_MAX
158 * \brief Structure encapsulating all data necessary to traverse the
159 * elements of a SES configuration.
161 * The ses_iterator object simplifies the task of iterating through all
162 * elements detected via the SES configuration page by tracking the numerous
163 * element indexes that, instead of memoizing in the softc, we calculate
164 * on the fly during the traversal of the element objects. The various
165 * indexes are necessary due to the varying needs of matching objects in
166 * the different SES pages. Some pages (e.g. Status/Control) contain all
167 * elements, while others (e.g. Additional Element Status) only contain
168 * individual elements (no overal status elements) of particular types.
170 * To use an iterator, initialize it with ses_iter_init(), and then
171 * use ses_iter_next() to traverse the elements (including the first) in
172 * the configuration. Once an iterator is initiailized with ses_iter_init(),
173 * you may also seek to any particular element by either it's global or
174 * individual element index via the ses_iter_seek_to() function. You may
175 * also return an iterator to the position just before the first element
176 * (i.e. the same state as after an ses_iter_init()), with ses_iter_reset().
178 struct ses_iterator {
180 * \brief Backlink to the overal software configuration structure.
182 * This is included for convenience so the iteration functions
183 * need only take a single, struct ses_iterator *, argument.
190 * \brief Index of the type of the current element within the
191 * ses_cache's ses_types array.
196 * \brief The position (0 based) of this element relative to all other
197 * elements of this type.
199 * This index resets to zero every time the iterator transitions
200 * to elements of a new type in the configuration.
202 int type_element_index;
205 * \brief The position (0 based) of this element relative to all
206 * other individual status elements in the configuration.
208 * This index ranges from 0 through the number of individual
209 * elements in the configuration. When the iterator returns
210 * an overall status element, individual_element_index is
211 * set to ITERATOR_INDEX_INVALID, to indicate that it does
212 * not apply to the current element.
214 int individual_element_index;
217 * \brief The position (0 based) of this element relative to
218 * all elements in the configration.
220 * This index is appropriate for indexing into enc->ses_elm_map.
222 int global_element_index;
225 * \brief The last valid individual element index of this
228 * When an iterator traverses an overal status element, the
229 * individual element index is reset to ITERATOR_INDEX_INVALID
230 * to prevent unintential use of the individual_element_index
231 * field. The saved_individual_element_index allows the iterator
232 * to restore it's position in the individual elements upon
233 * reaching the next individual element.
235 int saved_individual_element_index;
241 SES_UPDATE_GETCONFIG,
242 SES_UPDATE_GETSTATUS,
243 SES_UPDATE_GETELMDESCS,
244 SES_UPDATE_GETELMADDLSTATUS,
245 SES_PROCESS_CONTROL_REQS,
246 SES_PUBLISH_PHYSPATHS,
248 SES_NUM_UPDATE_STATES
251 static enc_softc_cleanup_t ses_softc_cleanup;
255 static fsm_fill_handler_t ses_fill_rcv_diag_io;
256 static fsm_fill_handler_t ses_fill_control_request;
257 static fsm_done_handler_t ses_process_pages;
258 static fsm_done_handler_t ses_process_config;
259 static fsm_done_handler_t ses_process_status;
260 static fsm_done_handler_t ses_process_elm_descs;
261 static fsm_done_handler_t ses_process_elm_addlstatus;
262 static fsm_done_handler_t ses_process_control_request;
263 static fsm_done_handler_t ses_publish_physpaths;
264 static fsm_done_handler_t ses_publish_cache;
266 static struct enc_fsm_state enc_fsm_states[SES_NUM_UPDATE_STATES] =
268 { "SES_UPDATE_NONE", 0, 0, 0, NULL, NULL, NULL },
274 ses_fill_rcv_diag_io,
279 "SES_UPDATE_GETCONFIG",
283 ses_fill_rcv_diag_io,
288 "SES_UPDATE_GETSTATUS",
292 ses_fill_rcv_diag_io,
297 "SES_UPDATE_GETELMDESCS",
298 SesElementDescriptor,
301 ses_fill_rcv_diag_io,
302 ses_process_elm_descs,
306 "SES_UPDATE_GETELMADDLSTATUS",
307 SesAddlElementStatus,
310 ses_fill_rcv_diag_io,
311 ses_process_elm_addlstatus,
315 "SES_PROCESS_CONTROL_REQS",
319 ses_fill_control_request,
320 ses_process_control_request,
324 "SES_PUBLISH_PHYSPATHS",
329 ses_publish_physpaths,
343 typedef struct ses_cache {
344 /* Source for all the configuration data pointers */
345 const struct ses_cfg_page *cfg_page;
347 /* References into the config page. */
349 const struct ses_enc_desc * const *subencs;
351 const ses_type_t *ses_types;
353 /* Source for all the status pointers */
354 const struct ses_status_page *status_page;
356 /* Source for all the object descriptor pointers */
357 const struct ses_elem_descr_page *elm_descs_page;
359 /* Source for all the additional object status pointers */
360 const struct ses_addl_elem_status_page *elm_addlstatus_page;
364 typedef struct ses_softc {
366 #define SES_FLAG_TIMEDCOMP 0x01
367 #define SES_FLAG_ADDLSTATUS 0x02
368 #define SES_FLAG_DESC 0x04
370 ses_control_reqlist_t ses_requests;
371 ses_control_reqlist_t ses_pending_requests;
375 * \brief Reset a SES iterator to just before the first element
376 * in the configuration.
378 * \param iter The iterator object to reset.
380 * The indexes within a reset iterator are invalid and will only
381 * become valid upon completion of a ses_iter_seek_to() or a
385 ses_iter_reset(struct ses_iterator *iter)
388 * Set our indexes to just before the first valid element
389 * of the first type (ITERATOR_INDEX_INVALID == -1). This
390 * simplifies the implementation of ses_iter_next().
392 iter->type_index = 0;
393 iter->type_element_index = ITERATOR_INDEX_INVALID;
394 iter->global_element_index = ITERATOR_INDEX_INVALID;
395 iter->individual_element_index = ITERATOR_INDEX_INVALID;
396 iter->saved_individual_element_index = ITERATOR_INDEX_INVALID;
400 * \brief Initialize the storage of a SES iterator and reset it to
401 * the position just before the first element of the
404 * \param enc The SES softc for the SES instance whose configuration
405 * will be enumerated by this iterator.
406 * \param iter The iterator object to initialize.
409 ses_iter_init(enc_softc_t *enc, enc_cache_t *cache, struct ses_iterator *iter)
413 ses_iter_reset(iter);
417 * \brief Traverse the provided SES iterator to the next element
418 * within the configuraiton.
420 * \param iter The iterator to move.
422 * \return If a valid next element exists, a pointer to it's enc_element_t.
425 static enc_element_t *
426 ses_iter_next(struct ses_iterator *iter)
428 ses_cache_t *ses_cache;
429 const ses_type_t *element_type;
431 ses_cache = iter->cache->private;
434 * Note: Treat nelms as signed, so we will hit this case
435 * and immediately terminate the iteration if the
436 * configuration has 0 objects.
438 if (iter->global_element_index >= (int)iter->cache->nelms - 1) {
440 /* Elements exhausted. */
441 iter->type_index = ITERATOR_INDEX_END;
442 iter->type_element_index = ITERATOR_INDEX_END;
443 iter->global_element_index = ITERATOR_INDEX_END;
444 iter->individual_element_index = ITERATOR_INDEX_END;
448 KASSERT((iter->type_index < ses_cache->ses_ntypes),
449 ("Corrupted element iterator. %d not less than %d",
450 iter->type_index, ses_cache->ses_ntypes));
452 element_type = &ses_cache->ses_types[iter->type_index];
453 iter->global_element_index++;
454 iter->type_element_index++;
457 * There is an object for overal type status in addition
458 * to one for each allowed element, but only if the element
461 if (iter->type_element_index > element_type->hdr->etype_maxelt) {
464 * We've exhausted the elements of this type.
465 * This next element belongs to the next type.
468 iter->type_element_index = 0;
469 iter->saved_individual_element_index
470 = iter->individual_element_index;
471 iter->individual_element_index = ITERATOR_INDEX_INVALID;
474 if (iter->type_element_index > 0) {
475 if (iter->type_element_index == 1) {
476 iter->individual_element_index
477 = iter->saved_individual_element_index;
479 iter->individual_element_index++;
482 return (&iter->cache->elm_map[iter->global_element_index]);
486 * Element index types tracked by a SES iterator.
490 * Index relative to all elements (overall and individual)
493 SES_ELEM_INDEX_GLOBAL,
496 * \brief Index relative to all individual elements in the system.
498 * This index counts only individual elements, skipping overall
499 * status elements. This is the index space of the additional
500 * element status page (page 0xa).
502 SES_ELEM_INDEX_INDIVIDUAL
503 } ses_elem_index_type_t;
506 * \brief Move the provided iterator forwards or backwards to the object
507 * having the give index.
509 * \param iter The iterator on which to perform the seek.
510 * \param element_index The index of the element to find.
511 * \param index_type The type (global or individual) of element_index.
513 * \return If the element is found, a pointer to it's enc_element_t.
516 static enc_element_t *
517 ses_iter_seek_to(struct ses_iterator *iter, int element_index,
518 ses_elem_index_type_t index_type)
520 enc_element_t *element;
523 if (index_type == SES_ELEM_INDEX_GLOBAL)
524 cur_index = &iter->global_element_index;
526 cur_index = &iter->individual_element_index;
528 if (*cur_index == element_index) {
530 return (&iter->cache->elm_map[iter->global_element_index]);
533 ses_iter_reset(iter);
534 while ((element = ses_iter_next(iter)) != NULL
535 && *cur_index != element_index)
538 if (*cur_index != element_index)
545 static int ses_encode(enc_softc_t *, uint8_t *, int, int,
546 struct ses_comstat *);
548 static int ses_set_timed_completion(enc_softc_t *, uint8_t);
550 static int ses_putstatus(enc_softc_t *, int, struct ses_comstat *);
553 static void ses_print_addl_data(enc_softc_t *, enc_element_t *);
555 /*=========================== SES cleanup routines ===========================*/
558 ses_cache_free_elm_addlstatus(enc_softc_t *enc, enc_cache_t *cache)
560 ses_cache_t *ses_cache;
561 ses_cache_t *other_ses_cache;
562 enc_element_t *cur_elm;
563 enc_element_t *last_elm;
565 ENC_DLOG(enc, "%s: enter\n", __func__);
566 ses_cache = cache->private;
567 if (ses_cache->elm_addlstatus_page == NULL)
570 for (cur_elm = cache->elm_map,
571 last_elm = &cache->elm_map[cache->nelms];
572 cur_elm != last_elm; cur_elm++) {
573 ses_element_t *elmpriv;
575 elmpriv = cur_elm->elm_private;
577 /* Clear references to the additional status page. */
578 bzero(&elmpriv->addl, sizeof(elmpriv->addl));
581 other_ses_cache = enc_other_cache(enc, cache)->private;
582 if (other_ses_cache->elm_addlstatus_page
583 != ses_cache->elm_addlstatus_page)
584 ENC_FREE(ses_cache->elm_addlstatus_page);
585 ses_cache->elm_addlstatus_page = NULL;
589 ses_cache_free_elm_descs(enc_softc_t *enc, enc_cache_t *cache)
591 ses_cache_t *ses_cache;
592 ses_cache_t *other_ses_cache;
593 enc_element_t *cur_elm;
594 enc_element_t *last_elm;
596 ENC_DLOG(enc, "%s: enter\n", __func__);
597 ses_cache = cache->private;
598 if (ses_cache->elm_descs_page == NULL)
601 for (cur_elm = cache->elm_map,
602 last_elm = &cache->elm_map[cache->nelms];
603 cur_elm != last_elm; cur_elm++) {
604 ses_element_t *elmpriv;
606 elmpriv = cur_elm->elm_private;
607 elmpriv->descr_len = 0;
608 elmpriv->descr = NULL;
611 other_ses_cache = enc_other_cache(enc, cache)->private;
612 if (other_ses_cache->elm_descs_page
613 != ses_cache->elm_descs_page)
614 ENC_FREE(ses_cache->elm_descs_page);
615 ses_cache->elm_descs_page = NULL;
619 ses_cache_free_status(enc_softc_t *enc, enc_cache_t *cache)
621 ses_cache_t *ses_cache;
622 ses_cache_t *other_ses_cache;
624 ENC_DLOG(enc, "%s: enter\n", __func__);
625 ses_cache = cache->private;
626 if (ses_cache->status_page == NULL)
629 other_ses_cache = enc_other_cache(enc, cache)->private;
630 if (other_ses_cache->status_page != ses_cache->status_page)
631 ENC_FREE(ses_cache->status_page);
632 ses_cache->status_page = NULL;
636 ses_cache_free_elm_map(enc_softc_t *enc, enc_cache_t *cache)
638 enc_element_t *cur_elm;
639 enc_element_t *last_elm;
641 ENC_DLOG(enc, "%s: enter\n", __func__);
642 if (cache->elm_map == NULL)
645 ses_cache_free_elm_descs(enc, cache);
646 ses_cache_free_elm_addlstatus(enc, cache);
647 for (cur_elm = cache->elm_map,
648 last_elm = &cache->elm_map[cache->nelms];
649 cur_elm != last_elm; cur_elm++) {
651 ENC_FREE_AND_NULL(cur_elm->elm_private);
653 ENC_FREE_AND_NULL(cache->elm_map);
655 ENC_DLOG(enc, "%s: exit\n", __func__);
659 ses_cache_free(enc_softc_t *enc, enc_cache_t *cache)
661 ses_cache_t *other_ses_cache;
662 ses_cache_t *ses_cache;
664 ENC_DLOG(enc, "%s: enter\n", __func__);
665 ses_cache_free_elm_addlstatus(enc, cache);
666 ses_cache_free_status(enc, cache);
667 ses_cache_free_elm_map(enc, cache);
669 ses_cache = cache->private;
670 ses_cache->ses_ntypes = 0;
672 other_ses_cache = enc_other_cache(enc, cache)->private;
673 if (other_ses_cache->subencs != ses_cache->subencs)
674 ENC_FREE(ses_cache->subencs);
675 ses_cache->subencs = NULL;
677 if (other_ses_cache->ses_types != ses_cache->ses_types)
678 ENC_FREE(ses_cache->ses_types);
679 ses_cache->ses_types = NULL;
681 if (other_ses_cache->cfg_page != ses_cache->cfg_page)
682 ENC_FREE(ses_cache->cfg_page);
683 ses_cache->cfg_page = NULL;
685 ENC_DLOG(enc, "%s: exit\n", __func__);
689 ses_cache_clone(enc_softc_t *enc, enc_cache_t *src, enc_cache_t *dst)
691 ses_cache_t *dst_ses_cache;
692 ses_cache_t *src_ses_cache;
693 enc_element_t *src_elm;
694 enc_element_t *dst_elm;
695 enc_element_t *last_elm;
697 ses_cache_free(enc, dst);
698 src_ses_cache = src->private;
699 dst_ses_cache = dst->private;
702 * The cloned enclosure cache and ses specific cache are
703 * mostly identical to the source.
706 *dst_ses_cache = *src_ses_cache;
709 * But the ses cache storage is still independent. Restore
710 * the pointer that was clobbered by the structure copy above.
712 dst->private = dst_ses_cache;
715 * The element map is independent even though it starts out
716 * pointing to the same constant page data.
718 dst->elm_map = malloc(dst->nelms * sizeof(enc_element_t),
719 M_SCSIENC, M_WAITOK);
720 memcpy(dst->elm_map, src->elm_map, dst->nelms * sizeof(enc_element_t));
721 for (dst_elm = dst->elm_map, src_elm = src->elm_map,
722 last_elm = &src->elm_map[src->nelms];
723 src_elm != last_elm; src_elm++, dst_elm++) {
725 dst_elm->elm_private = malloc(sizeof(ses_element_t),
726 M_SCSIENC, M_WAITOK);
727 memcpy(dst_elm->elm_private, src_elm->elm_private,
728 sizeof(ses_element_t));
732 /* Structure accessors. These are strongly typed to avoid errors. */
735 ses_elm_sas_descr_type(union ses_elm_sas_hdr *obj)
737 return ((obj)->base_hdr.byte1 >> 6);
740 ses_elm_addlstatus_proto(struct ses_elm_addlstatus_base_hdr *hdr)
742 return ((hdr)->byte0 & 0xf);
745 ses_elm_addlstatus_eip(struct ses_elm_addlstatus_base_hdr *hdr)
747 return ((hdr)->byte0 >> 4) & 0x1;
750 ses_elm_addlstatus_invalid(struct ses_elm_addlstatus_base_hdr *hdr)
752 return ((hdr)->byte0 >> 7);
755 ses_elm_sas_type0_not_all_phys(union ses_elm_sas_hdr *hdr)
757 return ((hdr)->type0_noneip.byte1 & 0x1);
760 ses_elm_sas_dev_phy_sata_dev(struct ses_elm_sas_device_phy *phy)
762 return ((phy)->target_ports & 0x1);
765 ses_elm_sas_dev_phy_sata_port(struct ses_elm_sas_device_phy *phy)
767 return ((phy)->target_ports >> 7);
770 ses_elm_sas_dev_phy_dev_type(struct ses_elm_sas_device_phy *phy)
772 return (((phy)->byte0 >> 4) & 0x7);
776 * \brief Verify that the cached configuration data in our softc
777 * is valid for processing the page data corresponding to
778 * the provided page header.
780 * \param ses_cache The SES cache to validate.
781 * \param gen_code The 4 byte generation code from a SES diagnostic
784 * \return non-zero if true, 0 if false.
787 ses_config_cache_valid(ses_cache_t *ses_cache, const uint8_t *gen_code)
792 if (ses_cache->cfg_page == NULL)
795 cache_gc = scsi_4btoul(ses_cache->cfg_page->hdr.gen_code);
796 cur_gc = scsi_4btoul(gen_code);
797 return (cache_gc == cur_gc);
801 * Function signature for consumers of the ses_devids_iter() interface.
803 typedef void ses_devid_callback_t(enc_softc_t *, enc_element_t *,
804 struct scsi_vpd_id_descriptor *, void *);
807 * \brief Iterate over and create vpd device id records from the
808 * additional element status data for elm, passing that data
809 * to the provided callback.
811 * \param enc SES instance containing elm
812 * \param elm Element for which to extract device ID data.
813 * \param callback The callback function to invoke on each generated
814 * device id descriptor for elm.
815 * \param callback_arg Argument passed through to callback on each invocation.
818 ses_devids_iter(enc_softc_t *enc, enc_element_t *elm,
819 ses_devid_callback_t *callback, void *callback_arg)
821 ses_element_t *elmpriv;
822 struct ses_addl_status *addl;
824 size_t devid_record_size;
826 elmpriv = elm->elm_private;
827 addl = &(elmpriv->addl);
830 * Don't assume this object has additional status information, or
831 * that it is a SAS device, or that it is a device slot device.
833 if (addl->hdr == NULL || addl->proto_hdr.sas == NULL
834 || addl->proto_data.sasdev_phys == NULL)
837 devid_record_size = SVPD_DEVICE_ID_DESC_HDR_LEN
838 + sizeof(struct scsi_vpd_id_naa_ieee_reg);
839 for (i = 0; i < addl->proto_hdr.sas->base_hdr.num_phys; i++) {
840 uint8_t devid_buf[devid_record_size];
841 struct scsi_vpd_id_descriptor *devid;
844 devid = (struct scsi_vpd_id_descriptor *)devid_buf;
845 phy_addr = addl->proto_data.sasdev_phys[i].phy_addr;
846 devid->proto_codeset = (SCSI_PROTO_SAS << SVPD_ID_PROTO_SHIFT)
847 | SVPD_ID_CODESET_BINARY;
848 devid->id_type = SVPD_ID_PIV
852 devid->length = sizeof(struct scsi_vpd_id_naa_ieee_reg);
853 memcpy(devid->identifier, phy_addr, devid->length);
855 callback(enc, elm, devid, callback_arg);
860 * Function signature for consumers of the ses_paths_iter() interface.
862 typedef void ses_path_callback_t(enc_softc_t *, enc_element_t *,
863 struct cam_path *, void *);
866 * Argument package passed through ses_devids_iter() by
867 * ses_paths_iter() to ses_path_iter_devid_callback().
869 typedef struct ses_path_iter_args {
870 ses_path_callback_t *callback;
872 } ses_path_iter_args_t;
875 * ses_devids_iter() callback function used by ses_paths_iter()
876 * to map device ids to peripheral driver instances.
878 * \param enc SES instance containing elm
879 * \param elm Element on which device ID matching is active.
880 * \param periph A device ID corresponding to elm.
881 * \param arg Argument passed through to callback on each invocation.
884 ses_path_iter_devid_callback(enc_softc_t *enc, enc_element_t *elem,
885 struct scsi_vpd_id_descriptor *devid,
888 struct ccb_dev_match cdm;
889 struct dev_match_pattern match_pattern;
890 struct dev_match_result match_result;
891 struct device_match_result *device_match;
892 struct device_match_pattern *device_pattern;
893 ses_path_iter_args_t *args;
895 args = (ses_path_iter_args_t *)arg;
896 match_pattern.type = DEV_MATCH_DEVICE;
897 device_pattern = &match_pattern.pattern.device_pattern;
898 device_pattern->flags = DEV_MATCH_DEVID;
899 device_pattern->data.devid_pat.id_len =
900 offsetof(struct scsi_vpd_id_descriptor, identifier)
902 memcpy(device_pattern->data.devid_pat.id, devid,
903 device_pattern->data.devid_pat.id_len);
905 memset(&cdm, 0, sizeof(cdm));
906 if (xpt_create_path(&cdm.ccb_h.path, /*periph*/NULL,
909 CAM_LUN_WILDCARD) != CAM_REQ_CMP)
912 cdm.ccb_h.func_code = XPT_DEV_MATCH;
913 cdm.num_patterns = 1;
914 cdm.patterns = &match_pattern;
915 cdm.pattern_buf_len = sizeof(match_pattern);
916 cdm.match_buf_len = sizeof(match_result);
917 cdm.matches = &match_result;
919 xpt_action((union ccb *)&cdm);
920 xpt_free_path(cdm.ccb_h.path);
922 if ((cdm.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP
923 || (cdm.status != CAM_DEV_MATCH_LAST
924 && cdm.status != CAM_DEV_MATCH_MORE)
925 || cdm.num_matches == 0)
928 device_match = &match_result.result.device_result;
929 if (xpt_create_path(&cdm.ccb_h.path, /*periph*/NULL,
930 device_match->path_id,
931 device_match->target_id,
932 device_match->target_lun) != CAM_REQ_CMP)
935 args->callback(enc, elem, cdm.ccb_h.path, args->callback_arg);
937 xpt_free_path(cdm.ccb_h.path);
941 * \brief Iterate over and find the matching periph objects for the
944 * \param enc SES instance containing elm
945 * \param elm Element for which to perform periph object matching.
946 * \param callback The callback function to invoke with each matching
948 * \param callback_arg Argument passed through to callback on each invocation.
951 ses_paths_iter(enc_softc_t *enc, enc_element_t *elm,
952 ses_path_callback_t *callback, void *callback_arg)
954 ses_path_iter_args_t args;
956 args.callback = callback;
957 args.callback_arg = callback_arg;
958 ses_devids_iter(enc, elm, ses_path_iter_devid_callback, &args);
962 * ses_paths_iter() callback function used by ses_get_elmdevname()
963 * to record periph driver instance strings corresponding to a SES
966 * \param enc SES instance containing elm
967 * \param elm Element on which periph matching is active.
968 * \param periph A periph instance that matches elm.
969 * \param arg Argument passed through to callback on each invocation.
972 ses_elmdevname_callback(enc_softc_t *enc, enc_element_t *elem,
973 struct cam_path *path, void *arg)
977 sb = (struct sbuf *)arg;
978 cam_periph_list(path, sb);
982 * Argument package passed through ses_paths_iter() to
983 * ses_getcampath_callback.
985 typedef struct ses_setphyspath_callback_args {
986 struct sbuf *physpath;
988 } ses_setphyspath_callback_args_t;
991 * \brief ses_paths_iter() callback to set the physical path on the
992 * CAM EDT entries corresponding to a given SES element.
994 * \param enc SES instance containing elm
995 * \param elm Element on which periph matching is active.
996 * \param periph A periph instance that matches elm.
997 * \param arg Argument passed through to callback on each invocation.
1000 ses_setphyspath_callback(enc_softc_t *enc, enc_element_t *elm,
1001 struct cam_path *path, void *arg)
1003 struct ccb_dev_advinfo cdai;
1004 ses_setphyspath_callback_args_t *args;
1007 args = (ses_setphyspath_callback_args_t *)arg;
1008 old_physpath = malloc(MAXPATHLEN, M_SCSIENC, M_WAITOK|M_ZERO);
1009 cam_periph_lock(enc->periph);
1010 xpt_setup_ccb(&cdai.ccb_h, path, CAM_PRIORITY_NORMAL);
1011 cdai.ccb_h.func_code = XPT_DEV_ADVINFO;
1012 cdai.buftype = CDAI_TYPE_PHYS_PATH;
1013 cdai.flags = CDAI_FLAG_NONE;
1014 cdai.bufsiz = MAXPATHLEN;
1015 cdai.buf = old_physpath;
1016 xpt_action((union ccb *)&cdai);
1017 if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0)
1018 cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE);
1020 if (strcmp(old_physpath, sbuf_data(args->physpath)) != 0) {
1022 xpt_setup_ccb(&cdai.ccb_h, path, CAM_PRIORITY_NORMAL);
1023 cdai.ccb_h.func_code = XPT_DEV_ADVINFO;
1024 cdai.buftype = CDAI_TYPE_PHYS_PATH;
1025 cdai.flags = CDAI_FLAG_STORE;
1026 cdai.bufsiz = sbuf_len(args->physpath);
1027 cdai.buf = sbuf_data(args->physpath);
1028 xpt_action((union ccb *)&cdai);
1029 if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0)
1030 cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE);
1031 if (cdai.ccb_h.status == CAM_REQ_CMP)
1034 cam_periph_unlock(enc->periph);
1035 free(old_physpath, M_SCSIENC);
1039 * \brief Set a device's physical path string in CAM XPT.
1041 * \param enc SES instance containing elm
1042 * \param elm Element to publish physical path string for
1043 * \param iter Iterator whose state corresponds to elm
1045 * \return 0 on success, errno otherwise.
1048 ses_set_physpath(enc_softc_t *enc, enc_element_t *elm,
1049 struct ses_iterator *iter)
1051 struct ccb_dev_advinfo cdai;
1052 ses_setphyspath_callback_args_t args;
1055 struct scsi_vpd_id_descriptor *idd;
1057 ses_element_t *elmpriv;
1064 * Assemble the components of the physical path starting with
1065 * the device ID of the enclosure itself.
1067 xpt_setup_ccb(&cdai.ccb_h, enc->periph->path, CAM_PRIORITY_NORMAL);
1068 cdai.ccb_h.func_code = XPT_DEV_ADVINFO;
1069 cdai.buftype = CDAI_TYPE_SCSI_DEVID;
1070 cdai.bufsiz = CAM_SCSI_DEVID_MAXLEN;
1071 cdai.buf = devid = malloc(cdai.bufsiz, M_SCSIENC, M_WAITOK|M_ZERO);
1072 cam_periph_lock(enc->periph);
1073 xpt_action((union ccb *)&cdai);
1074 if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0)
1075 cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE);
1076 cam_periph_unlock(enc->periph);
1077 if (cdai.ccb_h.status != CAM_REQ_CMP)
1080 idd = scsi_get_devid((struct scsi_vpd_device_id *)cdai.buf,
1081 cdai.provsiz, scsi_devid_is_naa_ieee_reg);
1085 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL) {
1089 /* Next, generate the physical path string */
1090 sbuf_printf(&sb, "id1,enc@n%jx/type@%x/slot@%x",
1091 scsi_8btou64(idd->identifier), iter->type_index,
1092 iter->type_element_index);
1093 /* Append the element descriptor if one exists */
1094 elmpriv = elm->elm_private;
1095 if (elmpriv->descr != NULL && elmpriv->descr_len > 0) {
1096 sbuf_cat(&sb, "/elmdesc@");
1097 for (i = 0, c = elmpriv->descr; i < elmpriv->descr_len;
1099 if (!isprint(*c) || isspace(*c) || *c == '/')
1100 sbuf_putc(&sb, '_');
1108 * Set this physical path on any CAM devices with a device ID
1109 * descriptor that matches one created from the SES additional
1110 * status data for this element.
1114 ses_paths_iter(enc, elm, ses_setphyspath_callback, &args);
1117 ret = args.num_set == 0 ? ENOENT : 0;
1126 * \brief Helper to set the CDB fields appropriately.
1128 * \param cdb Buffer containing the cdb.
1129 * \param pagenum SES diagnostic page to query for.
1130 * \param dir Direction of query.
1133 ses_page_cdb(char *cdb, int bufsiz, SesDiagPageCodes pagenum, int dir)
1136 /* Ref: SPC-4 r25 Section 6.20 Table 223 */
1137 if (dir == CAM_DIR_IN) {
1138 cdb[0] = RECEIVE_DIAGNOSTIC;
1139 cdb[1] = 1; /* Set page code valid bit */
1142 cdb[0] = SEND_DIAGNOSTIC;
1146 cdb[3] = bufsiz >> 8; /* high bits */
1147 cdb[4] = bufsiz & 0xff; /* low bits */
1152 * \brief Discover whether this instance supports timed completion of a
1153 * RECEIVE DIAGNOSTIC RESULTS command requesting the Enclosure Status
1154 * page, and store the result in the softc, updating if necessary.
1156 * \param enc SES instance to query and update.
1157 * \param tc_en Value of timed completion to set (see \return).
1159 * \return 1 if timed completion enabled, 0 otherwise.
1162 ses_set_timed_completion(enc_softc_t *enc, uint8_t tc_en)
1165 struct cam_periph *periph;
1166 struct ses_mgmt_mode_page *mgmt;
1168 size_t mode_buf_len;
1171 periph = enc->periph;
1172 ses = enc->enc_private;
1173 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1175 mode_buf_len = sizeof(struct ses_mgmt_mode_page);
1176 mode_buf = ENC_MALLOCZ(mode_buf_len);
1177 if (mode_buf == NULL)
1180 scsi_mode_sense(&ccb->csio, /*retries*/4, NULL, MSG_SIMPLE_Q_TAG,
1181 /*dbd*/FALSE, SMS_PAGE_CTRL_CURRENT, SES_MGMT_MODE_PAGE_CODE,
1182 mode_buf, mode_buf_len, SSD_FULL_SIZE, /*timeout*/60 * 1000);
1185 * Ignore illegal request errors, as they are quite common and we
1186 * will print something out in that case anyway.
1188 cam_periph_runccb(ccb, enc_error, ENC_CFLAGS,
1189 ENC_FLAGS|SF_QUIET_IR, NULL);
1190 if (ccb->ccb_h.status != CAM_REQ_CMP) {
1191 ENC_VLOG(enc, "Timed Completion Unsupported\n");
1195 /* Skip the mode select if the desired value is already set */
1196 mgmt = (struct ses_mgmt_mode_page *)mode_buf;
1197 if ((mgmt->byte5 & SES_MGMT_TIMED_COMP_EN) == tc_en)
1200 /* Value is not what we wanted, set it */
1202 mgmt->byte5 |= SES_MGMT_TIMED_COMP_EN;
1204 mgmt->byte5 &= ~SES_MGMT_TIMED_COMP_EN;
1205 /* SES2r20: a completion time of zero means as long as possible */
1206 bzero(&mgmt->max_comp_time, sizeof(mgmt->max_comp_time));
1208 scsi_mode_select(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG,
1209 /*page_fmt*/FALSE, /*save_pages*/TRUE, mode_buf, mode_buf_len,
1210 SSD_FULL_SIZE, /*timeout*/60 * 1000);
1212 cam_periph_runccb(ccb, enc_error, ENC_CFLAGS, ENC_FLAGS, NULL);
1213 if (ccb->ccb_h.status != CAM_REQ_CMP) {
1214 ENC_VLOG(enc, "Timed Completion Set Failed\n");
1219 if ((mgmt->byte5 & SES_MGMT_TIMED_COMP_EN) != 0) {
1220 ENC_LOG(enc, "Timed Completion Enabled\n");
1221 ses->ses_flags |= SES_FLAG_TIMEDCOMP;
1223 ENC_LOG(enc, "Timed Completion Disabled\n");
1224 ses->ses_flags &= ~SES_FLAG_TIMEDCOMP;
1228 xpt_release_ccb(ccb);
1230 return (ses->ses_flags & SES_FLAG_TIMEDCOMP);
1234 * \brief Process the list of supported pages and update flags.
1236 * \param enc SES device to query.
1237 * \param buf Buffer containing the config page.
1238 * \param xfer_len Length of the config page in the buffer.
1240 * \return 0 on success, errno otherwise.
1243 ses_process_pages(enc_softc_t *enc, struct enc_fsm_state *state,
1244 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1247 struct scsi_diag_page *page;
1250 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE,
1251 ("entering %s(%p, %d)\n", __func__, bufp, xfer_len));
1252 ses = enc->enc_private;
1259 if (xfer_len < sizeof(*page)) {
1260 ENC_VLOG(enc, "Unable to parse Diag Pages List Header\n");
1264 page = (struct scsi_diag_page *)*bufp;
1265 length = scsi_2btoul(page->length);
1266 if (length + offsetof(struct scsi_diag_page, params) > xfer_len) {
1267 ENC_VLOG(enc, "Diag Pages List Too Long\n");
1270 ENC_DLOG(enc, "%s: page length %d, xfer_len %d\n",
1271 __func__, length, xfer_len);
1274 for (i = 0; i < length; i++) {
1275 if (page->params[i] == SesElementDescriptor)
1276 ses->ses_flags |= SES_FLAG_DESC;
1277 else if (page->params[i] == SesAddlElementStatus)
1278 ses->ses_flags |= SES_FLAG_ADDLSTATUS;
1282 ENC_DLOG(enc, "%s: exiting with err %d\n", __func__, err);
1287 * \brief Process the config page and update associated structures.
1289 * \param enc SES device to query.
1290 * \param buf Buffer containing the config page.
1291 * \param xfer_len Length of the config page in the buffer.
1293 * \return 0 on success, errno otherwise.
1296 ses_process_config(enc_softc_t *enc, struct enc_fsm_state *state,
1297 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1299 struct ses_iterator iter;
1301 enc_cache_t *enc_cache;
1302 ses_cache_t *ses_cache;
1308 struct ses_cfg_page *cfg_page;
1309 struct ses_enc_desc *buf_subenc;
1310 const struct ses_enc_desc **subencs;
1311 const struct ses_enc_desc **cur_subenc;
1312 const struct ses_enc_desc **last_subenc;
1313 ses_type_t *ses_types;
1314 ses_type_t *sestype;
1315 const struct ses_elm_type_desc *cur_buf_type;
1316 const struct ses_elm_type_desc *last_buf_type;
1317 uint8_t *last_valid_byte;
1318 enc_element_t *element;
1319 const char *type_text;
1321 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE,
1322 ("entering %s(%p, %d)\n", __func__, bufp, xfer_len));
1323 ses = enc->enc_private;
1324 enc_cache = &enc->enc_daemon_cache;
1325 ses_cache = enc_cache->private;
1333 if (xfer_len < sizeof(cfg_page->hdr)) {
1334 ENC_VLOG(enc, "Unable to parse SES Config Header\n");
1339 cfg_page = (struct ses_cfg_page *)buf;
1340 length = ses_page_length(&cfg_page->hdr);
1341 if (length > xfer_len) {
1342 ENC_VLOG(enc, "Enclosure Config Page Too Long\n");
1345 last_valid_byte = &buf[length - 1];
1347 ENC_DLOG(enc, "%s: total page length %d, xfer_len %d\n",
1348 __func__, length, xfer_len);
1351 if (ses_config_cache_valid(ses_cache, cfg_page->hdr.gen_code)) {
1353 /* Our cache is still valid. Proceed to fetching status. */
1357 /* Cache is no longer valid. Free old data to make way for new. */
1358 ses_cache_free(enc, enc_cache);
1359 ENC_VLOG(enc, "Generation Code 0x%x has %d SubEnclosures\n",
1360 scsi_4btoul(cfg_page->hdr.gen_code),
1361 ses_cfg_page_get_num_subenc(cfg_page));
1363 /* Take ownership of the buffer. */
1364 ses_cache->cfg_page = cfg_page;
1368 * Now waltz through all the subenclosures summing the number of
1369 * types available in each.
1371 subencs = malloc(ses_cfg_page_get_num_subenc(cfg_page)
1372 * sizeof(*subencs), M_SCSIENC, M_WAITOK|M_ZERO);
1374 * Sub-enclosure data is const after construction (i.e. when
1375 * accessed via our cache object.
1377 * The cast here is not required in C++ but C99 is not so
1378 * sophisticated (see C99 6.5.16.1(1)).
1380 ses_cache->ses_nsubencs = ses_cfg_page_get_num_subenc(cfg_page);
1381 ses_cache->subencs = subencs;
1383 buf_subenc = cfg_page->subencs;
1384 cur_subenc = subencs;
1385 last_subenc = &subencs[ses_cache->ses_nsubencs - 1];
1387 while (cur_subenc <= last_subenc) {
1389 if (!ses_enc_desc_is_complete(buf_subenc, last_valid_byte)) {
1390 ENC_VLOG(enc, "Enclosure %d Beyond End of "
1391 "Descriptors\n", cur_subenc - subencs);
1396 ENC_VLOG(enc, " SubEnclosure ID %d, %d Types With this ID, "
1397 "Descriptor Length %d, offset %d\n", buf_subenc->subenc_id,
1398 buf_subenc->num_types, buf_subenc->length,
1399 &buf_subenc->byte0 - buf);
1400 ENC_VLOG(enc, "WWN: %jx\n",
1401 (uintmax_t)scsi_8btou64(buf_subenc->logical_id));
1403 ntype += buf_subenc->num_types;
1404 *cur_subenc = buf_subenc;
1406 buf_subenc = ses_enc_desc_next(buf_subenc);
1409 /* Process the type headers. */
1410 ses_types = malloc(ntype * sizeof(*ses_types),
1411 M_SCSIENC, M_WAITOK|M_ZERO);
1413 * Type data is const after construction (i.e. when accessed via
1416 ses_cache->ses_ntypes = ntype;
1417 ses_cache->ses_types = ses_types;
1419 cur_buf_type = (const struct ses_elm_type_desc *)
1420 (&(*last_subenc)->length + (*last_subenc)->length + 1);
1421 last_buf_type = cur_buf_type + ntype - 1;
1422 type_text = (const uint8_t *)(last_buf_type + 1);
1424 sestype = ses_types;
1425 while (cur_buf_type <= last_buf_type) {
1426 if (&cur_buf_type->etype_txt_len > last_valid_byte) {
1427 ENC_VLOG(enc, "Runt Enclosure Type Header %d\n",
1428 sestype - ses_types);
1432 sestype->hdr = cur_buf_type;
1433 sestype->text = type_text;
1434 type_text += cur_buf_type->etype_txt_len;
1435 ENC_VLOG(enc, " Type Desc[%d]: Type 0x%x, MaxElt %d, In Subenc "
1436 "%d, Text Length %d: %.*s\n", sestype - ses_types,
1437 sestype->hdr->etype_elm_type, sestype->hdr->etype_maxelt,
1438 sestype->hdr->etype_subenc, sestype->hdr->etype_txt_len,
1439 sestype->hdr->etype_txt_len, sestype->text);
1441 nelm += sestype->hdr->etype_maxelt
1442 + /*overall status element*/1;
1447 /* Create the object map. */
1448 enc_cache->elm_map = malloc(nelm * sizeof(enc_element_t),
1449 M_SCSIENC, M_WAITOK|M_ZERO);
1450 enc_cache->nelms = nelm;
1452 ses_iter_init(enc, enc_cache, &iter);
1453 while ((element = ses_iter_next(&iter)) != NULL) {
1454 const struct ses_elm_type_desc *thdr;
1456 ENC_DLOG(enc, "%s: checking obj %d(%d,%d)\n", __func__,
1457 iter.global_element_index, iter.type_index, nelm,
1458 iter.type_element_index);
1459 thdr = ses_cache->ses_types[iter.type_index].hdr;
1460 element->subenclosure = thdr->etype_subenc;
1461 element->enctype = thdr->etype_elm_type;
1462 element->overall_status_elem = iter.type_element_index == 0;
1463 element->elm_private = malloc(sizeof(ses_element_t),
1464 M_SCSIENC, M_WAITOK|M_ZERO);
1465 ENC_DLOG(enc, "%s: creating elmpriv %d(%d,%d) subenc %d "
1466 "type 0x%x\n", __func__, iter.global_element_index,
1467 iter.type_index, iter.type_element_index,
1468 thdr->etype_subenc, thdr->etype_elm_type);
1475 ses_cache_free(enc, enc_cache);
1477 enc_update_request(enc, SES_UPDATE_GETSTATUS);
1478 if (ses->ses_flags & SES_FLAG_DESC)
1479 enc_update_request(enc, SES_UPDATE_GETELMDESCS);
1480 if (ses->ses_flags & SES_FLAG_ADDLSTATUS)
1481 enc_update_request(enc, SES_UPDATE_GETELMADDLSTATUS);
1482 enc_update_request(enc, SES_PUBLISH_CACHE);
1484 ENC_DLOG(enc, "%s: exiting with err %d\n", __func__, err);
1489 * \brief Update the status page and associated structures.
1491 * \param enc SES softc to update for.
1492 * \param buf Buffer containing the status page.
1493 * \param bufsz Amount of data in the buffer.
1495 * \return 0 on success, errno otherwise.
1498 ses_process_status(enc_softc_t *enc, struct enc_fsm_state *state,
1499 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1501 struct ses_iterator iter;
1502 enc_element_t *element;
1504 enc_cache_t *enc_cache;
1505 ses_cache_t *ses_cache;
1509 struct ses_status_page *page;
1510 union ses_status_element *cur_stat;
1511 union ses_status_element *last_stat;
1513 ses = enc->enc_private;
1514 enc_cache = &enc->enc_daemon_cache;
1515 ses_cache = enc_cache->private;
1518 ENC_DLOG(enc, "%s: enter (%p, %p, %d)\n", __func__, enc, buf, xfer_len);
1519 page = (struct ses_status_page *)buf;
1520 length = ses_page_length(&page->hdr);
1527 * Make sure the length fits in the buffer.
1529 * XXX all this means is that the page is larger than the space
1530 * we allocated. Since we use a statically sized buffer, this
1531 * could happen... Need to use dynamic discovery of the size.
1533 if (length > xfer_len) {
1534 ENC_VLOG(enc, "Enclosure Status Page Too Long\n");
1538 /* Check for simple enclosure reporting short enclosure status. */
1539 if (length >= 4 && page->hdr.page_code == SesShortStatus) {
1540 ENC_DLOG(enc, "Got Short Enclosure Status page\n");
1541 ses->ses_flags &= ~(SES_FLAG_ADDLSTATUS | SES_FLAG_DESC);
1542 ses_cache_free(enc, enc_cache);
1543 enc_cache->enc_status = page->hdr.page_specific_flags;
1544 enc_update_request(enc, SES_PUBLISH_CACHE);
1549 /* Make sure the length contains at least one header and status */
1550 if (length < (sizeof(*page) + sizeof(*page->elements))) {
1551 ENC_VLOG(enc, "Enclosure Status Page Too Short\n");
1555 if (!ses_config_cache_valid(ses_cache, page->hdr.gen_code)) {
1556 ENC_DLOG(enc, "%s: Generation count change detected\n",
1558 enc_update_request(enc, SES_UPDATE_GETCONFIG);
1562 ses_cache_free_status(enc, enc_cache);
1563 ses_cache->status_page = page;
1566 enc_cache->enc_status = page->hdr.page_specific_flags;
1569 * Read in individual element status. The element order
1570 * matches the order reported in the config page (i.e. the
1571 * order of an unfiltered iteration of the config objects)..
1573 ses_iter_init(enc, enc_cache, &iter);
1574 cur_stat = page->elements;
1575 last_stat = (union ses_status_element *)
1576 &buf[length - sizeof(*last_stat)];
1577 ENC_DLOG(enc, "%s: total page length %d, xfer_len %d\n",
1578 __func__, length, xfer_len);
1579 while (cur_stat <= last_stat
1580 && (element = ses_iter_next(&iter)) != NULL) {
1582 ENC_DLOG(enc, "%s: obj %d(%d,%d) off=0x%tx status=%jx\n",
1583 __func__, iter.global_element_index, iter.type_index,
1584 iter.type_element_index, (uint8_t *)cur_stat - buf,
1585 scsi_4btoul(cur_stat->bytes));
1587 memcpy(&element->encstat, cur_stat, sizeof(element->encstat));
1588 element->svalid = 1;
1592 if (ses_iter_next(&iter) != NULL) {
1593 ENC_VLOG(enc, "Status page, length insufficient for "
1594 "expected number of objects\n");
1596 if (cur_stat <= last_stat)
1597 ENC_VLOG(enc, "Status page, exhausted objects before "
1598 "exhausing page\n");
1599 enc_update_request(enc, SES_PUBLISH_CACHE);
1603 ENC_DLOG(enc, "%s: exiting with error %d\n", __func__, err);
1609 * The enclosure should not provide additional element
1610 * status for this element type in page 0x0A.
1612 * \note This status is returned for any types not
1613 * listed SES3r02. Further types added in a
1614 * future specification will be incorrectly
1617 TYPE_ADDLSTATUS_NONE,
1620 * The element type provides additional element status
1623 TYPE_ADDLSTATUS_MANDATORY,
1626 * The element type may provide additional element status
1627 * in page 0x0A, but i
1629 TYPE_ADDLSTATUS_OPTIONAL
1630 } ses_addlstatus_avail_t;
1633 * \brief Check to see whether a given type (as obtained via type headers) is
1634 * supported by the additional status command.
1636 * \param enc SES softc to check.
1637 * \param typidx Type index to check for.
1639 * \return An enumeration indicating if additional status is mandatory,
1640 * optional, or not required for this type.
1642 static ses_addlstatus_avail_t
1643 ses_typehasaddlstatus(enc_softc_t *enc, uint8_t typidx)
1645 enc_cache_t *enc_cache;
1646 ses_cache_t *ses_cache;
1648 enc_cache = &enc->enc_daemon_cache;
1649 ses_cache = enc_cache->private;
1650 switch(ses_cache->ses_types[typidx].hdr->etype_elm_type) {
1652 case ELMTYP_ARRAY_DEV:
1653 case ELMTYP_SAS_EXP:
1654 return (TYPE_ADDLSTATUS_MANDATORY);
1655 case ELMTYP_SCSI_INI:
1656 case ELMTYP_SCSI_TGT:
1658 return (TYPE_ADDLSTATUS_OPTIONAL);
1660 /* No additional status information available. */
1663 return (TYPE_ADDLSTATUS_NONE);
1666 static int ses_get_elm_addlstatus_fc(enc_softc_t *, enc_cache_t *,
1668 static int ses_get_elm_addlstatus_sas(enc_softc_t *, enc_cache_t *, uint8_t *,
1669 int, int, int, int);
1672 * \brief Parse the additional status element data for each object.
1674 * \param enc The SES softc to update.
1675 * \param buf The buffer containing the additional status
1677 * \param xfer_len Size of the buffer.
1679 * \return 0 on success, errno otherwise.
1682 ses_process_elm_addlstatus(enc_softc_t *enc, struct enc_fsm_state *state,
1683 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1685 struct ses_iterator iter, titer;
1688 int ignore_index = 0;
1691 enc_cache_t *enc_cache;
1692 ses_cache_t *ses_cache;
1694 ses_element_t *elmpriv;
1695 const struct ses_page_hdr *hdr;
1696 enc_element_t *element, *telement;
1698 enc_cache = &enc->enc_daemon_cache;
1699 ses_cache = enc_cache->private;
1707 ses_cache_free_elm_addlstatus(enc, enc_cache);
1708 ses_cache->elm_addlstatus_page =
1709 (struct ses_addl_elem_status_page *)buf;
1713 * The objects appear in the same order here as in Enclosure Status,
1714 * which itself is ordered by the Type Descriptors from the Config
1715 * page. However, it is necessary to skip elements that are not
1716 * supported by this page when counting them.
1718 hdr = &ses_cache->elm_addlstatus_page->hdr;
1719 length = ses_page_length(hdr);
1720 ENC_DLOG(enc, "Additional Element Status Page Length 0x%x\n", length);
1721 /* Make sure the length includes at least one header. */
1722 if (length < sizeof(*hdr)+sizeof(struct ses_elm_addlstatus_base_hdr)) {
1723 ENC_VLOG(enc, "Runt Additional Element Status Page\n");
1726 if (length > xfer_len) {
1727 ENC_VLOG(enc, "Additional Element Status Page Too Long\n");
1731 if (!ses_config_cache_valid(ses_cache, hdr->gen_code)) {
1732 ENC_DLOG(enc, "%s: Generation count change detected\n",
1734 enc_update_request(enc, SES_UPDATE_GETCONFIG);
1738 offset = sizeof(struct ses_page_hdr);
1739 ses_iter_init(enc, enc_cache, &iter);
1740 while (offset < length
1741 && (element = ses_iter_next(&iter)) != NULL) {
1742 struct ses_elm_addlstatus_base_hdr *elm_hdr;
1744 ses_addlstatus_avail_t status_type;
1747 * Additional element status is only provided for
1748 * individual elements (i.e. overal status elements
1749 * are excluded) and those of the types specified
1752 status_type = ses_typehasaddlstatus(enc, iter.type_index);
1753 if (iter.individual_element_index == ITERATOR_INDEX_INVALID
1754 || status_type == TYPE_ADDLSTATUS_NONE)
1757 elm_hdr = (struct ses_elm_addlstatus_base_hdr *)&buf[offset];
1758 eip = ses_elm_addlstatus_eip(elm_hdr);
1759 if (eip && !ignore_index) {
1760 struct ses_elm_addlstatus_eip_hdr *eip_hdr;
1761 int expected_index, index;
1762 ses_elem_index_type_t index_type;
1764 eip_hdr = (struct ses_elm_addlstatus_eip_hdr *)elm_hdr;
1765 if (eip_hdr->byte2 & SES_ADDL_EIP_EIIOE) {
1766 index_type = SES_ELEM_INDEX_GLOBAL;
1767 expected_index = iter.global_element_index;
1769 index_type = SES_ELEM_INDEX_INDIVIDUAL;
1770 expected_index = iter.individual_element_index;
1773 telement = ses_iter_seek_to(&titer,
1774 eip_hdr->element_index, index_type);
1775 if (telement != NULL &&
1776 (ses_typehasaddlstatus(enc, titer.type_index) !=
1777 TYPE_ADDLSTATUS_NONE ||
1778 titer.type_index > ELMTYP_SAS_CONN)) {
1784 if (eip_hdr->byte2 & SES_ADDL_EIP_EIIOE)
1785 index = iter.global_element_index;
1787 index = iter.individual_element_index;
1788 if (index > expected_index
1789 && status_type == TYPE_ADDLSTATUS_MANDATORY) {
1790 ENC_VLOG(enc, "%s: provided %s element"
1791 "index %d skips mandatory status "
1792 " element at index %d\n",
1793 __func__, (eip_hdr->byte2 &
1794 SES_ADDL_EIP_EIIOE) ? "global " : "",
1795 index, expected_index);
1798 elmpriv = element->elm_private;
1799 elmpriv->addl.hdr = elm_hdr;
1800 ENC_DLOG(enc, "%s: global element index=%d, type index=%d "
1801 "type element index=%d, offset=0x%x, "
1802 "byte0=0x%x, length=0x%x\n", __func__,
1803 iter.global_element_index, iter.type_index,
1804 iter.type_element_index, offset, elmpriv->addl.hdr->byte0,
1805 elmpriv->addl.hdr->length);
1807 /* Skip to after the length field */
1808 offset += sizeof(struct ses_elm_addlstatus_base_hdr);
1810 /* Make sure the descriptor is within bounds */
1811 if ((offset + elmpriv->addl.hdr->length) > length) {
1812 ENC_VLOG(enc, "Element %d Beyond End "
1813 "of Additional Element Status Descriptors\n",
1814 iter.global_element_index);
1818 /* Advance to the protocol data, skipping eip bytes if needed */
1819 offset += (eip * SES_EIP_HDR_EXTRA_LEN);
1820 proto_info_len = elmpriv->addl.hdr->length
1821 - (eip * SES_EIP_HDR_EXTRA_LEN);
1823 /* Errors in this block are ignored as they are non-fatal */
1824 switch(ses_elm_addlstatus_proto(elmpriv->addl.hdr)) {
1826 if (elmpriv->addl.hdr->length == 0)
1828 ses_get_elm_addlstatus_fc(enc, enc_cache,
1829 &buf[offset], proto_info_len);
1831 case SPSP_PROTO_SAS:
1832 if (elmpriv->addl.hdr->length <= 2)
1834 ses_get_elm_addlstatus_sas(enc, enc_cache,
1837 eip, iter.type_index,
1838 iter.global_element_index);
1841 ENC_VLOG(enc, "Element %d: Unknown Additional Element "
1842 "Protocol 0x%x\n", iter.global_element_index,
1843 ses_elm_addlstatus_proto(elmpriv->addl.hdr));
1847 offset += proto_info_len;
1852 ses_cache_free_elm_addlstatus(enc, enc_cache);
1853 enc_update_request(enc, SES_PUBLISH_PHYSPATHS);
1854 enc_update_request(enc, SES_PUBLISH_CACHE);
1859 ses_process_control_request(enc_softc_t *enc, struct enc_fsm_state *state,
1860 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1864 ses = enc->enc_private;
1867 * o Generation count wrong.
1868 * o Some SCSI status error.
1870 ses_terminate_control_requests(&ses->ses_pending_requests, error);
1871 enc_update_request(enc, SES_UPDATE_GETSTATUS);
1876 ses_publish_physpaths(enc_softc_t *enc, struct enc_fsm_state *state,
1877 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1879 struct ses_iterator iter;
1880 enc_cache_t *enc_cache;
1881 enc_element_t *element;
1883 enc_cache = &enc->enc_daemon_cache;
1885 ses_iter_init(enc, enc_cache, &iter);
1886 while ((element = ses_iter_next(&iter)) != NULL) {
1888 * ses_set_physpath() returns success if we changed
1889 * the physpath of any element. This allows us to
1890 * only announce devices once regardless of how
1891 * many times we process additional element status.
1893 if (ses_set_physpath(enc, element, &iter) == 0)
1894 ses_print_addl_data(enc, element);
1901 ses_publish_cache(enc_softc_t *enc, struct enc_fsm_state *state,
1902 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1905 sx_xlock(&enc->enc_cache_lock);
1906 ses_cache_clone(enc, /*src*/&enc->enc_daemon_cache,
1907 /*dst*/&enc->enc_cache);
1908 sx_xunlock(&enc->enc_cache_lock);
1914 * \brief Parse the descriptors for each object.
1916 * \param enc The SES softc to update.
1917 * \param buf The buffer containing the descriptor list response.
1918 * \param xfer_len Size of the buffer.
1920 * \return 0 on success, errno otherwise.
1923 ses_process_elm_descs(enc_softc_t *enc, struct enc_fsm_state *state,
1924 union ccb *ccb, uint8_t **bufp, int error, int xfer_len)
1927 struct ses_iterator iter;
1928 enc_element_t *element;
1931 u_long length, plength;
1932 enc_cache_t *enc_cache;
1933 ses_cache_t *ses_cache;
1935 ses_element_t *elmpriv;
1936 const struct ses_page_hdr *phdr;
1937 const struct ses_elm_desc_hdr *hdr;
1939 ses = enc->enc_private;
1940 enc_cache = &enc->enc_daemon_cache;
1941 ses_cache = enc_cache->private;
1949 ses_cache_free_elm_descs(enc, enc_cache);
1950 ses_cache->elm_descs_page = (struct ses_elem_descr_page *)buf;
1953 phdr = &ses_cache->elm_descs_page->hdr;
1954 plength = ses_page_length(phdr);
1955 if (xfer_len < sizeof(struct ses_page_hdr)) {
1956 ENC_VLOG(enc, "Runt Element Descriptor Page\n");
1959 if (plength > xfer_len) {
1960 ENC_VLOG(enc, "Element Descriptor Page Too Long\n");
1964 if (!ses_config_cache_valid(ses_cache, phdr->gen_code)) {
1965 ENC_VLOG(enc, "%s: Generation count change detected\n",
1967 enc_update_request(enc, SES_UPDATE_GETCONFIG);
1971 offset = sizeof(struct ses_page_hdr);
1973 ses_iter_init(enc, enc_cache, &iter);
1974 while (offset < plength
1975 && (element = ses_iter_next(&iter)) != NULL) {
1977 if ((offset + sizeof(struct ses_elm_desc_hdr)) > plength) {
1978 ENC_VLOG(enc, "Element %d Descriptor Header Past "
1979 "End of Buffer\n", iter.global_element_index);
1982 hdr = (struct ses_elm_desc_hdr *)&buf[offset];
1983 length = scsi_2btoul(hdr->length);
1984 ENC_DLOG(enc, "%s: obj %d(%d,%d) length=%d off=%d\n", __func__,
1985 iter.global_element_index, iter.type_index,
1986 iter.type_element_index, length, offset);
1987 if ((offset + sizeof(*hdr) + length) > plength) {
1988 ENC_VLOG(enc, "Element%d Descriptor Past "
1989 "End of Buffer\n", iter.global_element_index);
1992 offset += sizeof(*hdr);
1995 elmpriv = element->elm_private;
1996 elmpriv->descr_len = length;
1997 elmpriv->descr = &buf[offset];
2000 /* skip over the descriptor itself */
2007 if (ses->ses_flags & SES_FLAG_ADDLSTATUS)
2008 enc_update_request(enc, SES_UPDATE_GETELMADDLSTATUS);
2010 enc_update_request(enc, SES_PUBLISH_CACHE);
2015 ses_fill_rcv_diag_io(enc_softc_t *enc, struct enc_fsm_state *state,
2016 union ccb *ccb, uint8_t *buf)
2019 if (enc->enc_type == ENC_SEMB_SES) {
2020 semb_receive_diagnostic_results(&ccb->ataio, /*retries*/5,
2021 NULL, MSG_SIMPLE_Q_TAG, /*pcv*/1,
2022 state->page_code, buf, state->buf_size,
2025 scsi_receive_diagnostic_results(&ccb->csio, /*retries*/5,
2026 NULL, MSG_SIMPLE_Q_TAG, /*pcv*/1,
2027 state->page_code, buf, state->buf_size,
2028 SSD_FULL_SIZE, state->timeout);
2034 * \brief Encode the object status into the response buffer, which is
2035 * expected to contain the current enclosure status. This function
2036 * turns off all the 'select' bits for the objects except for the
2037 * object specified, then sends it back to the enclosure.
2039 * \param enc SES enclosure the change is being applied to.
2040 * \param buf Buffer containing the current enclosure status response.
2041 * \param amt Length of the response in the buffer.
2042 * \param req The control request to be applied to buf.
2044 * \return 0 on success, errno otherwise.
2047 ses_encode(enc_softc_t *enc, uint8_t *buf, int amt, ses_control_request_t *req)
2049 struct ses_iterator iter;
2050 enc_element_t *element;
2052 struct ses_control_page_hdr *hdr;
2054 ses_iter_init(enc, &enc->enc_cache, &iter);
2055 hdr = (struct ses_control_page_hdr *)buf;
2056 if (req->elm_idx == -1) {
2057 /* for enclosure status, at least 2 bytes are needed */
2060 hdr->control_flags =
2061 req->elm_stat.comstatus & SES_SET_STATUS_MASK;
2062 ENC_DLOG(enc, "Set EncStat %x\n", hdr->control_flags);
2066 element = ses_iter_seek_to(&iter, req->elm_idx, SES_ELEM_INDEX_GLOBAL);
2067 if (element == NULL)
2071 * Seek to the type set that corresponds to the requested object.
2072 * The +1 is for the overall status element for the type.
2074 offset = sizeof(struct ses_control_page_hdr)
2075 + (iter.global_element_index * sizeof(struct ses_comstat));
2077 /* Check for buffer overflow. */
2078 if (offset + sizeof(struct ses_comstat) > amt)
2081 /* Set the status. */
2082 memcpy(&buf[offset], &req->elm_stat, sizeof(struct ses_comstat));
2084 ENC_DLOG(enc, "Set Type 0x%x Obj 0x%x (offset %d) with %x %x %x %x\n",
2085 iter.type_index, iter.global_element_index, offset,
2086 req->elm_stat.comstatus, req->elm_stat.comstat[0],
2087 req->elm_stat.comstat[1], req->elm_stat.comstat[2]);
2093 ses_fill_control_request(enc_softc_t *enc, struct enc_fsm_state *state,
2094 union ccb *ccb, uint8_t *buf)
2097 enc_cache_t *enc_cache;
2098 ses_cache_t *ses_cache;
2099 struct ses_control_page_hdr *hdr;
2100 ses_control_request_t *req;
2104 ses = enc->enc_private;
2105 enc_cache = &enc->enc_daemon_cache;
2106 ses_cache = enc_cache->private;
2107 hdr = (struct ses_control_page_hdr *)buf;
2109 if (ses_cache->status_page == NULL) {
2110 ses_terminate_control_requests(&ses->ses_requests, EIO);
2114 plength = ses_page_length(&ses_cache->status_page->hdr);
2115 memcpy(buf, ses_cache->status_page, plength);
2117 /* Disable the select bits in all status entries. */
2118 offset = sizeof(struct ses_control_page_hdr);
2119 for (offset = sizeof(struct ses_control_page_hdr);
2120 offset < plength; offset += sizeof(struct ses_comstat)) {
2121 buf[offset] &= ~SESCTL_CSEL;
2124 /* And make sure the INVOP bit is clear. */
2125 hdr->control_flags &= ~SES_ENCSTAT_INVOP;
2127 /* Apply incoming requests. */
2128 while ((req = TAILQ_FIRST(&ses->ses_requests)) != NULL) {
2130 TAILQ_REMOVE(&ses->ses_requests, req, links);
2131 req->result = ses_encode(enc, buf, plength, req);
2132 if (req->result != 0) {
2136 TAILQ_INSERT_TAIL(&ses->ses_pending_requests, req, links);
2139 if (TAILQ_EMPTY(&ses->ses_pending_requests) != 0)
2142 /* Fill out the ccb */
2143 if (enc->enc_type == ENC_SEMB_SES) {
2144 semb_send_diagnostic(&ccb->ataio, /*retries*/5, NULL,
2146 buf, ses_page_length(&ses_cache->status_page->hdr),
2149 scsi_send_diagnostic(&ccb->csio, /*retries*/5, NULL,
2150 MSG_SIMPLE_Q_TAG, /*unit_offline*/0,
2151 /*device_offline*/0, /*self_test*/0,
2152 /*page_format*/1, /*self_test_code*/0,
2153 buf, ses_page_length(&ses_cache->status_page->hdr),
2154 SSD_FULL_SIZE, state->timeout);
2160 ses_get_elm_addlstatus_fc(enc_softc_t *enc, enc_cache_t *enc_cache,
2161 uint8_t *buf, int bufsiz)
2163 ENC_VLOG(enc, "FC Device Support Stubbed in Additional Status Page\n");
2167 #define SES_PRINT_PORTS(p, type) do { \
2168 sbuf_printf(sbp, " %s(", type); \
2169 if (((p) & SES_SASOBJ_DEV_PHY_PROTOMASK) == 0) \
2170 sbuf_printf(sbp, " None"); \
2172 if ((p) & SES_SASOBJ_DEV_PHY_SMP) \
2173 sbuf_printf(sbp, " SMP"); \
2174 if ((p) & SES_SASOBJ_DEV_PHY_STP) \
2175 sbuf_printf(sbp, " STP"); \
2176 if ((p) & SES_SASOBJ_DEV_PHY_SSP) \
2177 sbuf_printf(sbp, " SSP"); \
2179 sbuf_printf(sbp, " )"); \
2183 * \brief Print the additional element status data for this object, for SAS
2184 * type 0 objects. See SES2 r20 Section 6.1.13.3.2.
2186 * \param sesname SES device name associated with the object.
2187 * \param sbp Sbuf to print to.
2188 * \param obj The object to print the data for.
2189 * \param periph_name Peripheral string associated with the object.
2192 ses_print_addl_data_sas_type0(char *sesname, struct sbuf *sbp,
2193 enc_element_t *obj, char *periph_name)
2196 ses_element_t *elmpriv;
2197 struct ses_addl_status *addl;
2198 struct ses_elm_sas_device_phy *phy;
2200 elmpriv = obj->elm_private;
2201 addl = &(elmpriv->addl);
2202 if (addl->proto_hdr.sas == NULL)
2204 sbuf_printf(sbp, "%s: %s: SAS Device Slot Element:",
2205 sesname, periph_name);
2206 sbuf_printf(sbp, " %d Phys", addl->proto_hdr.sas->base_hdr.num_phys);
2207 if (ses_elm_addlstatus_eip(addl->hdr))
2208 sbuf_printf(sbp, " at Slot %d",
2209 addl->proto_hdr.sas->type0_eip.dev_slot_num);
2210 if (ses_elm_sas_type0_not_all_phys(addl->proto_hdr.sas))
2211 sbuf_printf(sbp, ", Not All Phys");
2212 sbuf_printf(sbp, "\n");
2213 if (addl->proto_data.sasdev_phys == NULL)
2215 for (i = 0;i < addl->proto_hdr.sas->base_hdr.num_phys;i++) {
2216 phy = &addl->proto_data.sasdev_phys[i];
2217 sbuf_printf(sbp, "%s: phy %d:", sesname, i);
2218 if (ses_elm_sas_dev_phy_sata_dev(phy))
2219 /* Spec says all other fields are specific values */
2220 sbuf_printf(sbp, " SATA device\n");
2222 sbuf_printf(sbp, " SAS device type %d id %d\n",
2223 ses_elm_sas_dev_phy_dev_type(phy), phy->phy_id);
2224 sbuf_printf(sbp, "%s: phy %d: protocols:", sesname, i);
2225 SES_PRINT_PORTS(phy->initiator_ports, "Initiator");
2226 SES_PRINT_PORTS(phy->target_ports, "Target");
2227 sbuf_printf(sbp, "\n");
2229 sbuf_printf(sbp, "%s: phy %d: parent %jx addr %jx\n",
2231 (uintmax_t)scsi_8btou64(phy->parent_addr),
2232 (uintmax_t)scsi_8btou64(phy->phy_addr));
2235 #undef SES_PRINT_PORTS
2238 * \brief Report whether a given enclosure object is an expander.
2240 * \param enc SES softc associated with object.
2241 * \param obj Enclosure object to report for.
2243 * \return 1 if true, 0 otherwise.
2246 ses_obj_is_expander(enc_softc_t *enc, enc_element_t *obj)
2248 return (obj->enctype == ELMTYP_SAS_EXP);
2252 * \brief Print the additional element status data for this object, for SAS
2253 * type 1 objects. See SES2 r20 Sections 6.1.13.3.3 and 6.1.13.3.4.
2255 * \param enc SES enclosure, needed for type identification.
2256 * \param sesname SES device name associated with the object.
2257 * \param sbp Sbuf to print to.
2258 * \param obj The object to print the data for.
2259 * \param periph_name Peripheral string associated with the object.
2262 ses_print_addl_data_sas_type1(enc_softc_t *enc, char *sesname,
2263 struct sbuf *sbp, enc_element_t *obj, char *periph_name)
2266 ses_element_t *elmpriv;
2267 struct ses_addl_status *addl;
2268 struct ses_elm_sas_expander_phy *exp_phy;
2269 struct ses_elm_sas_port_phy *port_phy;
2271 elmpriv = obj->elm_private;
2272 addl = &(elmpriv->addl);
2273 if (addl->proto_hdr.sas == NULL)
2275 sbuf_printf(sbp, "%s: %s: SAS ", sesname, periph_name);
2276 if (ses_obj_is_expander(enc, obj)) {
2277 num_phys = addl->proto_hdr.sas->base_hdr.num_phys;
2278 sbuf_printf(sbp, "Expander: %d Phys", num_phys);
2279 if (addl->proto_data.sasexp_phys == NULL)
2281 for (i = 0;i < num_phys;i++) {
2282 exp_phy = &addl->proto_data.sasexp_phys[i];
2283 sbuf_printf(sbp, "%s: phy %d: connector %d other %d\n",
2284 sesname, i, exp_phy->connector_index,
2285 exp_phy->other_index);
2288 num_phys = addl->proto_hdr.sas->base_hdr.num_phys;
2289 sbuf_printf(sbp, "Port: %d Phys", num_phys);
2290 if (addl->proto_data.sasport_phys == NULL)
2292 for (i = 0;i < num_phys;i++) {
2293 port_phy = &addl->proto_data.sasport_phys[i];
2295 "%s: phy %d: id %d connector %d other %d\n",
2296 sesname, i, port_phy->phy_id,
2297 port_phy->connector_index, port_phy->other_index);
2298 sbuf_printf(sbp, "%s: phy %d: addr %jx\n", sesname, i,
2299 (uintmax_t)scsi_8btou64(port_phy->phy_addr));
2305 * \brief Print the additional element status data for this object.
2307 * \param enc SES softc associated with the object.
2308 * \param obj The object to print the data for.
2311 ses_print_addl_data(enc_softc_t *enc, enc_element_t *obj)
2313 ses_element_t *elmpriv;
2314 struct ses_addl_status *addl;
2315 struct sbuf sesname, name, out;
2317 elmpriv = obj->elm_private;
2318 if (elmpriv == NULL)
2321 addl = &(elmpriv->addl);
2322 if (addl->hdr == NULL)
2325 sbuf_new(&sesname, NULL, 16, SBUF_AUTOEXTEND);
2326 sbuf_new(&name, NULL, 16, SBUF_AUTOEXTEND);
2327 sbuf_new(&out, NULL, 512, SBUF_AUTOEXTEND);
2328 ses_paths_iter(enc, obj, ses_elmdevname_callback, &name);
2329 if (sbuf_len(&name) == 0)
2330 sbuf_printf(&name, "(none)");
2332 sbuf_printf(&sesname, "%s%d", enc->periph->periph_name,
2333 enc->periph->unit_number);
2334 sbuf_finish(&sesname);
2335 if (elmpriv->descr != NULL)
2336 sbuf_printf(&out, "%s: %s: Element descriptor: '%s'\n",
2337 sbuf_data(&sesname), sbuf_data(&name), elmpriv->descr);
2338 switch(ses_elm_addlstatus_proto(addl->hdr)) {
2339 case SPSP_PROTO_SAS:
2340 switch(ses_elm_sas_descr_type(addl->proto_hdr.sas)) {
2341 case SES_SASOBJ_TYPE_SLOT:
2342 ses_print_addl_data_sas_type0(sbuf_data(&sesname),
2343 &out, obj, sbuf_data(&name));
2345 case SES_SASOBJ_TYPE_OTHER:
2346 ses_print_addl_data_sas_type1(enc, sbuf_data(&sesname),
2347 &out, obj, sbuf_data(&name));
2353 case SPSP_PROTO_FC: /* stubbed for now */
2359 printf("%s", sbuf_data(&out));
2362 sbuf_delete(&sesname);
2366 * \brief Update the softc with the additional element status data for this
2367 * object, for SAS type 0 objects.
2369 * \param enc SES softc to be updated.
2370 * \param buf The additional element status response buffer.
2371 * \param bufsiz Size of the response buffer.
2372 * \param eip The EIP bit value.
2373 * \param nobj Number of objects attached to the SES softc.
2375 * \return 0 on success, errno otherwise.
2378 ses_get_elm_addlstatus_sas_type0(enc_softc_t *enc, enc_cache_t *enc_cache,
2379 uint8_t *buf, int bufsiz, int eip, int nobj)
2381 int err, offset, physz;
2383 ses_element_t *elmpriv;
2384 struct ses_addl_status *addl;
2388 /* basic object setup */
2389 obj = &(enc_cache->elm_map[nobj]);
2390 elmpriv = obj->elm_private;
2391 addl = &(elmpriv->addl);
2393 addl->proto_hdr.sas = (union ses_elm_sas_hdr *)&buf[offset];
2395 /* Don't assume this object has any phys */
2396 bzero(&addl->proto_data, sizeof(addl->proto_data));
2397 if (addl->proto_hdr.sas->base_hdr.num_phys == 0)
2400 /* Skip forward to the phy list */
2402 offset += sizeof(struct ses_elm_sas_type0_eip_hdr);
2404 offset += sizeof(struct ses_elm_sas_type0_base_hdr);
2406 /* Make sure the phy list fits in the buffer */
2407 physz = addl->proto_hdr.sas->base_hdr.num_phys;
2408 physz *= sizeof(struct ses_elm_sas_device_phy);
2409 if (physz > (bufsiz - offset + 4)) {
2410 ENC_VLOG(enc, "Element %d Device Phy List Beyond End Of Buffer\n",
2416 /* Point to the phy list */
2417 addl->proto_data.sasdev_phys =
2418 (struct ses_elm_sas_device_phy *)&buf[offset];
2425 * \brief Update the softc with the additional element status data for this
2426 * object, for SAS type 1 objects.
2428 * \param enc SES softc to be updated.
2429 * \param buf The additional element status response buffer.
2430 * \param bufsiz Size of the response buffer.
2431 * \param eip The EIP bit value.
2432 * \param nobj Number of objects attached to the SES softc.
2434 * \return 0 on success, errno otherwise.
2437 ses_get_elm_addlstatus_sas_type1(enc_softc_t *enc, enc_cache_t *enc_cache,
2438 uint8_t *buf, int bufsiz, int eip, int nobj)
2440 int err, offset, physz;
2442 ses_element_t *elmpriv;
2443 struct ses_addl_status *addl;
2447 /* basic object setup */
2448 obj = &(enc_cache->elm_map[nobj]);
2449 elmpriv = obj->elm_private;
2450 addl = &(elmpriv->addl);
2452 addl->proto_hdr.sas = (union ses_elm_sas_hdr *)&buf[offset];
2454 /* Don't assume this object has any phys */
2455 bzero(&addl->proto_data, sizeof(addl->proto_data));
2456 if (addl->proto_hdr.sas->base_hdr.num_phys == 0)
2459 /* Process expanders differently from other type1 cases */
2460 if (ses_obj_is_expander(enc, obj)) {
2461 offset += sizeof(struct ses_elm_sas_type1_expander_hdr);
2462 physz = addl->proto_hdr.sas->base_hdr.num_phys *
2463 sizeof(struct ses_elm_sas_expander_phy);
2464 if (physz > (bufsiz - offset)) {
2465 ENC_VLOG(enc, "Element %d: Expander Phy List Beyond "
2466 "End Of Buffer\n", nobj);
2470 addl->proto_data.sasexp_phys =
2471 (struct ses_elm_sas_expander_phy *)&buf[offset];
2473 offset += sizeof(struct ses_elm_sas_type1_nonexpander_hdr);
2474 physz = addl->proto_hdr.sas->base_hdr.num_phys *
2475 sizeof(struct ses_elm_sas_port_phy);
2476 if (physz > (bufsiz - offset + 4)) {
2477 ENC_VLOG(enc, "Element %d: Port Phy List Beyond End "
2478 "Of Buffer\n", nobj);
2482 addl->proto_data.sasport_phys =
2483 (struct ses_elm_sas_port_phy *)&buf[offset];
2491 * \brief Update the softc with the additional element status data for this
2492 * object, for SAS objects.
2494 * \param enc SES softc to be updated.
2495 * \param buf The additional element status response buffer.
2496 * \param bufsiz Size of the response buffer.
2497 * \param eip The EIP bit value.
2498 * \param tidx Type index for this object.
2499 * \param nobj Number of objects attached to the SES softc.
2501 * \return 0 on success, errno otherwise.
2504 ses_get_elm_addlstatus_sas(enc_softc_t *enc, enc_cache_t *enc_cache,
2505 uint8_t *buf, int bufsiz, int eip, int tidx,
2509 ses_cache_t *ses_cache;
2510 union ses_elm_sas_hdr *hdr;
2512 /* Need to be able to read the descriptor type! */
2513 if (bufsiz < sizeof(union ses_elm_sas_hdr)) {
2518 ses_cache = enc_cache->private;
2520 hdr = (union ses_elm_sas_hdr *)buf;
2521 dtype = ses_elm_sas_descr_type(hdr);
2523 case SES_SASOBJ_TYPE_SLOT:
2524 switch(ses_cache->ses_types[tidx].hdr->etype_elm_type) {
2526 case ELMTYP_ARRAY_DEV:
2529 ENC_VLOG(enc, "Element %d has Additional Status type 0, "
2530 "invalid for SES element type 0x%x\n", nobj,
2531 ses_cache->ses_types[tidx].hdr->etype_elm_type);
2535 err = ses_get_elm_addlstatus_sas_type0(enc, enc_cache,
2539 case SES_SASOBJ_TYPE_OTHER:
2540 switch(ses_cache->ses_types[tidx].hdr->etype_elm_type) {
2541 case ELMTYP_SAS_EXP:
2542 case ELMTYP_SCSI_INI:
2543 case ELMTYP_SCSI_TGT:
2547 ENC_VLOG(enc, "Element %d has Additional Status type 1, "
2548 "invalid for SES element type 0x%x\n", nobj,
2549 ses_cache->ses_types[tidx].hdr->etype_elm_type);
2553 err = ses_get_elm_addlstatus_sas_type1(enc, enc_cache, buf,
2557 ENC_VLOG(enc, "Element %d of type 0x%x has Additional Status "
2558 "of unknown type 0x%x\n", nobj,
2559 ses_cache->ses_types[tidx].hdr->etype_elm_type, dtype);
2569 ses_softc_invalidate(enc_softc_t *enc)
2573 ses = enc->enc_private;
2574 ses_terminate_control_requests(&ses->ses_requests, ENXIO);
2578 ses_softc_cleanup(enc_softc_t *enc)
2581 ses_cache_free(enc, &enc->enc_cache);
2582 ses_cache_free(enc, &enc->enc_daemon_cache);
2583 ENC_FREE_AND_NULL(enc->enc_private);
2584 ENC_FREE_AND_NULL(enc->enc_cache.private);
2585 ENC_FREE_AND_NULL(enc->enc_daemon_cache.private);
2589 ses_init_enc(enc_softc_t *enc)
2595 ses_get_enc_status(enc_softc_t *enc, int slpflag)
2597 /* Automatically updated, caller checks enc_cache->encstat itself */
2602 ses_set_enc_status(enc_softc_t *enc, uint8_t encstat, int slpflag)
2604 ses_control_request_t req;
2607 ses = enc->enc_private;
2608 req.elm_idx = SES_SETSTATUS_ENC_IDX;
2609 req.elm_stat.comstatus = encstat & 0xf;
2611 TAILQ_INSERT_TAIL(&ses->ses_requests, &req, links);
2612 enc_update_request(enc, SES_PROCESS_CONTROL_REQS);
2613 cam_periph_sleep(enc->periph, &req, PUSER, "encstat", 0);
2615 return (req.result);
2619 ses_get_elm_status(enc_softc_t *enc, encioc_elm_status_t *elms, int slpflag)
2621 unsigned int i = elms->elm_idx;
2623 memcpy(elms->cstat, &enc->enc_cache.elm_map[i].encstat, 4);
2628 ses_set_elm_status(enc_softc_t *enc, encioc_elm_status_t *elms, int slpflag)
2630 ses_control_request_t req;
2633 /* If this is clear, we don't do diddly. */
2634 if ((elms->cstat[0] & SESCTL_CSEL) == 0)
2637 ses = enc->enc_private;
2638 req.elm_idx = elms->elm_idx;
2639 memcpy(&req.elm_stat, elms->cstat, sizeof(req.elm_stat));
2641 TAILQ_INSERT_TAIL(&ses->ses_requests, &req, links);
2642 enc_update_request(enc, SES_PROCESS_CONTROL_REQS);
2643 cam_periph_sleep(enc->periph, &req, PUSER, "encstat", 0);
2645 return (req.result);
2649 ses_get_elm_desc(enc_softc_t *enc, encioc_elm_desc_t *elmd)
2651 int i = (int)elmd->elm_idx;
2652 ses_element_t *elmpriv;
2654 /* Assume caller has already checked obj_id validity */
2655 elmpriv = enc->enc_cache.elm_map[i].elm_private;
2656 /* object might not have a descriptor */
2657 if (elmpriv == NULL || elmpriv->descr == NULL) {
2658 elmd->elm_desc_len = 0;
2661 if (elmd->elm_desc_len > elmpriv->descr_len)
2662 elmd->elm_desc_len = elmpriv->descr_len;
2663 copyout(elmpriv->descr, elmd->elm_desc_str, elmd->elm_desc_len);
2668 * \brief Respond to ENCIOC_GETELMDEVNAME, providing a device name for the
2669 * given object id if one is available.
2671 * \param enc SES softc to examine.
2672 * \param objdn ioctl structure to read/write device name info.
2674 * \return 0 on success, errno otherwise.
2677 ses_get_elm_devnames(enc_softc_t *enc, encioc_elm_devnames_t *elmdn)
2682 len = elmdn->elm_names_size;
2686 cam_periph_unlock(enc->periph);
2687 sbuf_new(&sb, NULL, len, SBUF_FIXEDLEN);
2688 ses_paths_iter(enc, &enc->enc_cache.elm_map[elmdn->elm_idx],
2689 ses_elmdevname_callback, &sb);
2691 elmdn->elm_names_len = sbuf_len(&sb);
2692 copyout(sbuf_data(&sb), elmdn->elm_devnames, elmdn->elm_names_len + 1);
2693 cam_periph_lock(enc->periph);
2694 return (elmdn->elm_names_len > 0 ? 0 : ENODEV);
2698 * \brief Send a string to the primary subenclosure using the String Out
2699 * SES diagnostic page.
2701 * \param enc SES enclosure to run the command on.
2702 * \param sstr SES string structure to operate on
2703 * \param ioc Ioctl being performed
2705 * \return 0 on success, errno otherwise.
2708 ses_handle_string(enc_softc_t *enc, encioc_string_t *sstr, int ioc)
2711 enc_cache_t *enc_cache;
2712 ses_cache_t *ses_cache;
2713 const struct ses_enc_desc *enc_desc;
2714 int amt, payload, ret;
2723 ses = enc->enc_private;
2724 enc_cache = &enc->enc_daemon_cache;
2725 ses_cache = enc_cache->private;
2727 /* Implement SES2r20 6.1.6 */
2728 if (sstr->bufsiz > 0xffff)
2729 return (EINVAL); /* buffer size too large */
2731 if (ioc == ENCIOC_SETSTRING) {
2732 payload = sstr->bufsiz + 4; /* header for SEND DIAGNOSTIC */
2734 buf = ENC_MALLOC(payload);
2738 ses_page_cdb(cdb, payload, 0, CAM_DIR_OUT);
2739 /* Construct the page request */
2740 buf[0] = SesStringOut;
2742 buf[2] = sstr->bufsiz >> 8;
2743 buf[3] = sstr->bufsiz & 0xff;
2744 memcpy(&buf[4], sstr->buf, sstr->bufsiz);
2745 } else if (ioc == ENCIOC_GETSTRING) {
2746 payload = sstr->bufsiz;
2748 ses_page_cdb(cdb, payload, SesStringIn, CAM_DIR_IN);
2750 } else if (ioc == ENCIOC_GETENCNAME) {
2751 if (ses_cache->ses_nsubencs < 1)
2753 enc_desc = ses_cache->subencs[0];
2754 cam_strvis(vendor, enc_desc->vendor_id,
2755 sizeof(enc_desc->vendor_id), sizeof(vendor));
2756 cam_strvis(product, enc_desc->product_id,
2757 sizeof(enc_desc->product_id), sizeof(product));
2758 cam_strvis(rev, enc_desc->product_rev,
2759 sizeof(enc_desc->product_rev), sizeof(rev));
2760 rsize = snprintf(str, sizeof(str), "%s %s %s",
2761 vendor, product, rev) + 1;
2762 if (rsize > sizeof(str))
2763 rsize = sizeof(str);
2764 copyout(&rsize, &sstr->bufsiz, sizeof(rsize));
2766 if (size > sstr->bufsiz)
2767 size = sstr->bufsiz;
2768 copyout(str, sstr->buf, size);
2769 return (size == rsize ? 0 : ENOMEM);
2770 } else if (ioc == ENCIOC_GETENCID) {
2771 if (ses_cache->ses_nsubencs < 1)
2773 enc_desc = ses_cache->subencs[0];
2774 rsize = snprintf(str, sizeof(str), "%16jx",
2775 scsi_8btou64(enc_desc->logical_id)) + 1;
2776 if (rsize > sizeof(str))
2777 rsize = sizeof(str);
2778 copyout(&rsize, &sstr->bufsiz, sizeof(rsize));
2780 if (size > sstr->bufsiz)
2781 size = sstr->bufsiz;
2782 copyout(str, sstr->buf, size);
2783 return (size == rsize ? 0 : ENOMEM);
2787 ret = enc_runcmd(enc, cdb, 6, buf, &amt);
2788 if (ioc == ENCIOC_SETSTRING)
2794 * \invariant Called with cam_periph mutex held.
2797 ses_poll_status(enc_softc_t *enc)
2801 ses = enc->enc_private;
2802 enc_update_request(enc, SES_UPDATE_GETSTATUS);
2803 if (ses->ses_flags & SES_FLAG_ADDLSTATUS)
2804 enc_update_request(enc, SES_UPDATE_GETELMADDLSTATUS);
2808 * \brief Notification received when CAM detects a new device in the
2809 * SCSI domain in which this SEP resides.
2811 * \param enc SES enclosure instance.
2814 ses_device_found(enc_softc_t *enc)
2816 ses_poll_status(enc);
2817 enc_update_request(enc, SES_PUBLISH_PHYSPATHS);
2820 static struct enc_vec ses_enc_vec =
2822 .softc_invalidate = ses_softc_invalidate,
2823 .softc_cleanup = ses_softc_cleanup,
2824 .init_enc = ses_init_enc,
2825 .get_enc_status = ses_get_enc_status,
2826 .set_enc_status = ses_set_enc_status,
2827 .get_elm_status = ses_get_elm_status,
2828 .set_elm_status = ses_set_elm_status,
2829 .get_elm_desc = ses_get_elm_desc,
2830 .get_elm_devnames = ses_get_elm_devnames,
2831 .handle_string = ses_handle_string,
2832 .device_found = ses_device_found,
2833 .poll_status = ses_poll_status
2837 * \brief Initialize a new SES instance.
2839 * \param enc SES softc structure to set up the instance in.
2840 * \param doinit Do the initialization (see main driver).
2842 * \return 0 on success, errno otherwise.
2845 ses_softc_init(enc_softc_t *enc)
2847 ses_softc_t *ses_softc;
2849 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE,
2850 ("entering enc_softc_init(%p)\n", enc));
2852 enc->enc_vec = ses_enc_vec;
2853 enc->enc_fsm_states = enc_fsm_states;
2855 if (enc->enc_private == NULL)
2856 enc->enc_private = ENC_MALLOCZ(sizeof(ses_softc_t));
2857 if (enc->enc_cache.private == NULL)
2858 enc->enc_cache.private = ENC_MALLOCZ(sizeof(ses_cache_t));
2859 if (enc->enc_daemon_cache.private == NULL)
2860 enc->enc_daemon_cache.private =
2861 ENC_MALLOCZ(sizeof(ses_cache_t));
2863 if (enc->enc_private == NULL
2864 || enc->enc_cache.private == NULL
2865 || enc->enc_daemon_cache.private == NULL) {
2866 ENC_FREE_AND_NULL(enc->enc_private);
2867 ENC_FREE_AND_NULL(enc->enc_cache.private);
2868 ENC_FREE_AND_NULL(enc->enc_daemon_cache.private);
2872 ses_softc = enc->enc_private;
2873 TAILQ_INIT(&ses_softc->ses_requests);
2874 TAILQ_INIT(&ses_softc->ses_pending_requests);
2876 enc_update_request(enc, SES_UPDATE_PAGES);
2878 // XXX: Move this to the FSM so it doesn't hang init
2879 if (0) (void) ses_set_timed_completion(enc, 1);