1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2000 Matthew Jacob 5 * Copyright (c) 2010 Spectra Logic Corporation 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions, and the following disclaimer, 13 * without modification, immediately at the beginning of the file. 14 * 2. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 /** 31 * \file scsi_enc_ses.c 32 * 33 * Structures and routines specific && private to SES only 34 */ 35 36 #include <sys/param.h> 37 38 #include <sys/ctype.h> 39 #include <sys/errno.h> 40 #include <sys/kernel.h> 41 #include <sys/lock.h> 42 #include <sys/malloc.h> 43 #include <sys/mutex.h> 44 #include <sys/queue.h> 45 #include <sys/sbuf.h> 46 #include <sys/sx.h> 47 #include <sys/systm.h> 48 #include <sys/types.h> 49 50 #include <cam/cam.h> 51 #include <cam/cam_ccb.h> 52 #include <cam/cam_xpt_periph.h> 53 #include <cam/cam_periph.h> 54 55 #include <cam/scsi/scsi_message.h> 56 #include <cam/scsi/scsi_enc.h> 57 #include <cam/scsi/scsi_enc_internal.h> 58 59 /* SES Native Type Device Support */ 60 61 /* SES Diagnostic Page Codes */ 62 typedef enum { 63 SesSupportedPages = 0x0, 64 SesConfigPage = 0x1, 65 SesControlPage = 0x2, 66 SesStatusPage = SesControlPage, 67 SesHelpTxt = 0x3, 68 SesStringOut = 0x4, 69 SesStringIn = SesStringOut, 70 SesThresholdOut = 0x5, 71 SesThresholdIn = SesThresholdOut, 72 SesArrayControl = 0x6, /* Obsolete in SES v2 */ 73 SesArrayStatus = SesArrayControl, 74 SesElementDescriptor = 0x7, 75 SesShortStatus = 0x8, 76 SesEnclosureBusy = 0x9, 77 SesAddlElementStatus = 0xa 78 } SesDiagPageCodes; 79 80 typedef struct ses_type { 81 const struct ses_elm_type_desc *hdr; 82 const char *text; 83 } ses_type_t; 84 85 typedef struct ses_comstat { 86 uint8_t comstatus; 87 uint8_t comstat[3]; 88 } ses_comstat_t; 89 90 typedef union ses_addl_data { 91 struct ses_elm_sas_device_phy *sasdev_phys; 92 struct ses_elm_sas_expander_phy *sasexp_phys; 93 struct ses_elm_sas_port_phy *sasport_phys; 94 struct ses_fcobj_port *fc_ports; 95 } ses_add_data_t; 96 97 typedef struct ses_addl_status { 98 struct ses_elm_addlstatus_base_hdr *hdr; 99 union { 100 union ses_fcobj_hdr *fc; 101 union ses_elm_sas_hdr *sas; 102 struct ses_elm_ata_hdr *ata; 103 } proto_hdr; 104 union ses_addl_data proto_data; /* array sizes stored in header */ 105 } ses_add_status_t; 106 107 typedef struct ses_element { 108 uint8_t eip; /* eip bit is set */ 109 uint16_t descr_len; /* length of the descriptor */ 110 const char *descr; /* descriptor for this object */ 111 struct ses_addl_status addl; /* additional status info */ 112 } ses_element_t; 113 114 typedef struct ses_control_request { 115 int elm_idx; 116 ses_comstat_t elm_stat; 117 int result; 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; 122 enum { 123 SES_SETSTATUS_ENC_IDX = -1 124 }; 125 126 static void 127 ses_terminate_control_requests(ses_control_reqlist_t *reqlist, int result) 128 { 129 ses_control_request_t *req; 130 131 while ((req = TAILQ_FIRST(reqlist)) != NULL) { 132 TAILQ_REMOVE(reqlist, req, links); 133 req->result = result; 134 wakeup(req); 135 } 136 } 137 138 enum ses_iter_index_values { 139 /** 140 * \brief Value of an initialized but invalid index 141 * in a ses_iterator object. 142 * 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. 146 */ 147 ITERATOR_INDEX_INVALID = -1, 148 149 /** 150 * \brief Value of an index in a ses_iterator object 151 * when the iterator has traversed past the last 152 * valid element.. 153 */ 154 ITERATOR_INDEX_END = INT_MAX 155 }; 156 157 /** 158 * \brief Structure encapsulating all data necessary to traverse the 159 * elements of a SES configuration. 160 * 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. 169 * 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(). 177 */ 178 struct ses_iterator { 179 /** 180 * \brief Backlink to the overal software configuration structure. 181 * 182 * This is included for convenience so the iteration functions 183 * need only take a single, struct ses_iterator *, argument. 184 */ 185 enc_softc_t *enc; 186 187 enc_cache_t *cache; 188 189 /** 190 * \brief Index of the type of the current element within the 191 * ses_cache's ses_types array. 192 */ 193 int type_index; 194 195 /** 196 * \brief The position (0 based) of this element relative to all other 197 * elements of this type. 198 * 199 * This index resets to zero every time the iterator transitions 200 * to elements of a new type in the configuration. 201 */ 202 int type_element_index; 203 204 /** 205 * \brief The position (0 based) of this element relative to all 206 * other individual status elements in the configuration. 207 * 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. 213 */ 214 int individual_element_index; 215 216 /** 217 * \brief The position (0 based) of this element relative to 218 * all elements in the configration. 219 * 220 * This index is appropriate for indexing into enc->ses_elm_map. 221 */ 222 int global_element_index; 223 224 /** 225 * \brief The last valid individual element index of this 226 * iterator. 227 * 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. 234 */ 235 int saved_individual_element_index; 236 }; 237 238 typedef enum { 239 SES_UPDATE_NONE, 240 SES_UPDATE_PAGES, 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, 247 SES_PUBLISH_CACHE, 248 SES_NUM_UPDATE_STATES 249 } ses_update_action; 250 251 static enc_softc_cleanup_t ses_softc_cleanup; 252 253 #define SCSZ 0x8000 254 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; 265 266 static struct enc_fsm_state enc_fsm_states[SES_NUM_UPDATE_STATES] = 267 { 268 { "SES_UPDATE_NONE", 0, 0, 0, NULL, NULL, NULL }, 269 { 270 "SES_UPDATE_PAGES", 271 SesSupportedPages, 272 SCSZ, 273 60 * 1000, 274 ses_fill_rcv_diag_io, 275 ses_process_pages, 276 enc_error 277 }, 278 { 279 "SES_UPDATE_GETCONFIG", 280 SesConfigPage, 281 SCSZ, 282 60 * 1000, 283 ses_fill_rcv_diag_io, 284 ses_process_config, 285 enc_error 286 }, 287 { 288 "SES_UPDATE_GETSTATUS", 289 SesStatusPage, 290 SCSZ, 291 60 * 1000, 292 ses_fill_rcv_diag_io, 293 ses_process_status, 294 enc_error 295 }, 296 { 297 "SES_UPDATE_GETELMDESCS", 298 SesElementDescriptor, 299 SCSZ, 300 60 * 1000, 301 ses_fill_rcv_diag_io, 302 ses_process_elm_descs, 303 enc_error 304 }, 305 { 306 "SES_UPDATE_GETELMADDLSTATUS", 307 SesAddlElementStatus, 308 SCSZ, 309 60 * 1000, 310 ses_fill_rcv_diag_io, 311 ses_process_elm_addlstatus, 312 enc_error 313 }, 314 { 315 "SES_PROCESS_CONTROL_REQS", 316 SesControlPage, 317 SCSZ, 318 60 * 1000, 319 ses_fill_control_request, 320 ses_process_control_request, 321 enc_error 322 }, 323 { 324 "SES_PUBLISH_PHYSPATHS", 325 0, 326 0, 327 0, 328 NULL, 329 ses_publish_physpaths, 330 NULL 331 }, 332 { 333 "SES_PUBLISH_CACHE", 334 0, 335 0, 336 0, 337 NULL, 338 ses_publish_cache, 339 NULL 340 } 341 }; 342 343 typedef struct ses_cache { 344 /* Source for all the configuration data pointers */ 345 const struct ses_cfg_page *cfg_page; 346 347 /* References into the config page. */ 348 int ses_nsubencs; 349 const struct ses_enc_desc * const *subencs; 350 int ses_ntypes; 351 const ses_type_t *ses_types; 352 353 /* Source for all the status pointers */ 354 const struct ses_status_page *status_page; 355 356 /* Source for all the object descriptor pointers */ 357 const struct ses_elem_descr_page *elm_descs_page; 358 359 /* Source for all the additional object status pointers */ 360 const struct ses_addl_elem_status_page *elm_addlstatus_page; 361 362 } ses_cache_t; 363 364 typedef struct ses_softc { 365 uint32_t ses_flags; 366 #define SES_FLAG_TIMEDCOMP 0x01 367 #define SES_FLAG_ADDLSTATUS 0x02 368 #define SES_FLAG_DESC 0x04 369 370 ses_control_reqlist_t ses_requests; 371 ses_control_reqlist_t ses_pending_requests; 372 } ses_softc_t; 373 374 static int ses_search_globally = 0; 375 SYSCTL_INT(_kern_cam_enc, OID_AUTO, search_globally, CTLFLAG_RWTUN, 376 &ses_search_globally, 0, "Search for disks on other buses"); 377 378 /** 379 * \brief Reset a SES iterator to just before the first element 380 * in the configuration. 381 * 382 * \param iter The iterator object to reset. 383 * 384 * The indexes within a reset iterator are invalid and will only 385 * become valid upon completion of a ses_iter_seek_to() or a 386 * ses_iter_next(). 387 */ 388 static void 389 ses_iter_reset(struct ses_iterator *iter) 390 { 391 /* 392 * Set our indexes to just before the first valid element 393 * of the first type (ITERATOR_INDEX_INVALID == -1). This 394 * simplifies the implementation of ses_iter_next(). 395 */ 396 iter->type_index = 0; 397 iter->type_element_index = ITERATOR_INDEX_INVALID; 398 iter->global_element_index = ITERATOR_INDEX_INVALID; 399 iter->individual_element_index = ITERATOR_INDEX_INVALID; 400 iter->saved_individual_element_index = ITERATOR_INDEX_INVALID; 401 } 402 403 /** 404 * \brief Initialize the storage of a SES iterator and reset it to 405 * the position just before the first element of the 406 * configuration. 407 * 408 * \param enc The SES softc for the SES instance whose configuration 409 * will be enumerated by this iterator. 410 * \param iter The iterator object to initialize. 411 */ 412 static void 413 ses_iter_init(enc_softc_t *enc, enc_cache_t *cache, struct ses_iterator *iter) 414 { 415 iter->enc = enc; 416 iter->cache = cache; 417 ses_iter_reset(iter); 418 } 419 420 /** 421 * \brief Traverse the provided SES iterator to the next element 422 * within the configuration. 423 * 424 * \param iter The iterator to move. 425 * 426 * \return If a valid next element exists, a pointer to it's enc_element_t. 427 * Otherwise NULL. 428 */ 429 static enc_element_t * 430 ses_iter_next(struct ses_iterator *iter) 431 { 432 ses_cache_t *ses_cache; 433 const ses_type_t *element_type; 434 435 ses_cache = iter->cache->private; 436 437 /* 438 * Note: Treat nelms as signed, so we will hit this case 439 * and immediately terminate the iteration if the 440 * configuration has 0 objects. 441 */ 442 if (iter->global_element_index >= (int)iter->cache->nelms - 1) { 443 /* Elements exhausted. */ 444 iter->type_index = ITERATOR_INDEX_END; 445 iter->type_element_index = ITERATOR_INDEX_END; 446 iter->global_element_index = ITERATOR_INDEX_END; 447 iter->individual_element_index = ITERATOR_INDEX_END; 448 iter->saved_individual_element_index = ITERATOR_INDEX_END; 449 return (NULL); 450 } 451 452 KASSERT((iter->type_index < ses_cache->ses_ntypes), 453 ("Corrupted element iterator. %d not less than %d", 454 iter->type_index, ses_cache->ses_ntypes)); 455 456 element_type = &ses_cache->ses_types[iter->type_index]; 457 iter->global_element_index++; 458 iter->type_element_index++; 459 460 /* 461 * There is an object for overal type status in addition 462 * to one for each allowed element, but only if the element 463 * count is non-zero. 464 */ 465 if (iter->type_element_index > element_type->hdr->etype_maxelt) { 466 /* 467 * We've exhausted the elements of this type. 468 * This next element belongs to the next type. 469 */ 470 iter->type_index++; 471 iter->type_element_index = 0; 472 iter->individual_element_index = ITERATOR_INDEX_INVALID; 473 } 474 475 if (iter->type_element_index > 0) { 476 iter->individual_element_index = 477 ++iter->saved_individual_element_index; 478 } 479 480 return (&iter->cache->elm_map[iter->global_element_index]); 481 } 482 483 /** 484 * Element index types tracked by a SES iterator. 485 */ 486 typedef enum { 487 /** 488 * Index relative to all elements (overall and individual) 489 * in the system. 490 */ 491 SES_ELEM_INDEX_GLOBAL, 492 493 /** 494 * \brief Index relative to all individual elements in the system. 495 * 496 * This index counts only individual elements, skipping overall 497 * status elements. This is the index space of the additional 498 * element status page (page 0xa). 499 */ 500 SES_ELEM_INDEX_INDIVIDUAL 501 } ses_elem_index_type_t; 502 503 /** 504 * \brief Move the provided iterator forwards or backwards to the object 505 * having the give index. 506 * 507 * \param iter The iterator on which to perform the seek. 508 * \param element_index The index of the element to find. 509 * \param index_type The type (global or individual) of element_index. 510 * 511 * \return If the element is found, a pointer to it's enc_element_t. 512 * Otherwise NULL. 513 */ 514 static enc_element_t * 515 ses_iter_seek_to(struct ses_iterator *iter, int element_index, 516 ses_elem_index_type_t index_type) 517 { 518 enc_element_t *element; 519 int *cur_index; 520 521 if (index_type == SES_ELEM_INDEX_GLOBAL) 522 cur_index = &iter->global_element_index; 523 else 524 cur_index = &iter->individual_element_index; 525 526 if (*cur_index == element_index) { 527 /* Already there. */ 528 return (&iter->cache->elm_map[iter->global_element_index]); 529 } 530 531 ses_iter_reset(iter); 532 while ((element = ses_iter_next(iter)) != NULL 533 && *cur_index != element_index) 534 ; 535 536 if (*cur_index != element_index) 537 return (NULL); 538 539 return (element); 540 } 541 542 #if 0 543 static int ses_encode(enc_softc_t *, uint8_t *, int, int, 544 struct ses_comstat *); 545 #endif 546 static int ses_set_timed_completion(enc_softc_t *, uint8_t); 547 #if 0 548 static int ses_putstatus(enc_softc_t *, int, struct ses_comstat *); 549 #endif 550 551 static void ses_poll_status(enc_softc_t *); 552 static void ses_print_addl_data(enc_softc_t *, enc_element_t *); 553 554 /*=========================== SES cleanup routines ===========================*/ 555 556 static void 557 ses_cache_free_elm_addlstatus(enc_softc_t *enc, enc_cache_t *cache) 558 { 559 ses_cache_t *ses_cache; 560 ses_cache_t *other_ses_cache; 561 enc_element_t *cur_elm; 562 enc_element_t *last_elm; 563 564 ENC_DLOG(enc, "%s: enter\n", __func__); 565 ses_cache = cache->private; 566 if (ses_cache->elm_addlstatus_page == NULL) 567 return; 568 569 for (cur_elm = cache->elm_map, 570 last_elm = &cache->elm_map[cache->nelms]; 571 cur_elm != last_elm; cur_elm++) { 572 ses_element_t *elmpriv; 573 574 elmpriv = cur_elm->elm_private; 575 576 /* Clear references to the additional status page. */ 577 bzero(&elmpriv->addl, sizeof(elmpriv->addl)); 578 } 579 580 other_ses_cache = enc_other_cache(enc, cache)->private; 581 if (other_ses_cache->elm_addlstatus_page 582 != ses_cache->elm_addlstatus_page) 583 ENC_FREE(ses_cache->elm_addlstatus_page); 584 ses_cache->elm_addlstatus_page = NULL; 585 } 586 587 static void 588 ses_cache_free_elm_descs(enc_softc_t *enc, enc_cache_t *cache) 589 { 590 ses_cache_t *ses_cache; 591 ses_cache_t *other_ses_cache; 592 enc_element_t *cur_elm; 593 enc_element_t *last_elm; 594 595 ENC_DLOG(enc, "%s: enter\n", __func__); 596 ses_cache = cache->private; 597 if (ses_cache->elm_descs_page == NULL) 598 return; 599 600 for (cur_elm = cache->elm_map, 601 last_elm = &cache->elm_map[cache->nelms]; 602 cur_elm != last_elm; cur_elm++) { 603 ses_element_t *elmpriv; 604 605 elmpriv = cur_elm->elm_private; 606 elmpriv->descr_len = 0; 607 elmpriv->descr = NULL; 608 } 609 610 other_ses_cache = enc_other_cache(enc, cache)->private; 611 if (other_ses_cache->elm_descs_page 612 != ses_cache->elm_descs_page) 613 ENC_FREE(ses_cache->elm_descs_page); 614 ses_cache->elm_descs_page = NULL; 615 } 616 617 static void 618 ses_cache_free_status(enc_softc_t *enc, enc_cache_t *cache) 619 { 620 ses_cache_t *ses_cache; 621 ses_cache_t *other_ses_cache; 622 623 ENC_DLOG(enc, "%s: enter\n", __func__); 624 ses_cache = cache->private; 625 if (ses_cache->status_page == NULL) 626 return; 627 628 other_ses_cache = enc_other_cache(enc, cache)->private; 629 if (other_ses_cache->status_page != ses_cache->status_page) 630 ENC_FREE(ses_cache->status_page); 631 ses_cache->status_page = NULL; 632 } 633 634 static void 635 ses_cache_free_elm_map(enc_softc_t *enc, enc_cache_t *cache) 636 { 637 enc_element_t *cur_elm; 638 enc_element_t *last_elm; 639 640 ENC_DLOG(enc, "%s: enter\n", __func__); 641 if (cache->elm_map == NULL) 642 return; 643 644 ses_cache_free_elm_descs(enc, cache); 645 ses_cache_free_elm_addlstatus(enc, cache); 646 for (cur_elm = cache->elm_map, 647 last_elm = &cache->elm_map[cache->nelms]; 648 cur_elm != last_elm; cur_elm++) { 649 ENC_FREE_AND_NULL(cur_elm->elm_private); 650 } 651 ENC_FREE_AND_NULL(cache->elm_map); 652 cache->nelms = 0; 653 ENC_DLOG(enc, "%s: exit\n", __func__); 654 } 655 656 static void 657 ses_cache_free(enc_softc_t *enc, enc_cache_t *cache) 658 { 659 ses_cache_t *other_ses_cache; 660 ses_cache_t *ses_cache; 661 662 ENC_DLOG(enc, "%s: enter\n", __func__); 663 ses_cache_free_elm_addlstatus(enc, cache); 664 ses_cache_free_status(enc, cache); 665 ses_cache_free_elm_map(enc, cache); 666 667 ses_cache = cache->private; 668 ses_cache->ses_ntypes = 0; 669 670 other_ses_cache = enc_other_cache(enc, cache)->private; 671 if (other_ses_cache->subencs != ses_cache->subencs) 672 ENC_FREE(ses_cache->subencs); 673 ses_cache->subencs = NULL; 674 675 if (other_ses_cache->ses_types != ses_cache->ses_types) 676 ENC_FREE(ses_cache->ses_types); 677 ses_cache->ses_types = NULL; 678 679 if (other_ses_cache->cfg_page != ses_cache->cfg_page) 680 ENC_FREE(ses_cache->cfg_page); 681 ses_cache->cfg_page = NULL; 682 683 ENC_DLOG(enc, "%s: exit\n", __func__); 684 } 685 686 static void 687 ses_cache_clone(enc_softc_t *enc, enc_cache_t *src, enc_cache_t *dst) 688 { 689 ses_cache_t *dst_ses_cache; 690 ses_cache_t *src_ses_cache; 691 enc_element_t *src_elm; 692 enc_element_t *dst_elm; 693 enc_element_t *last_elm; 694 695 ses_cache_free(enc, dst); 696 src_ses_cache = src->private; 697 dst_ses_cache = dst->private; 698 699 /* 700 * The cloned enclosure cache and ses specific cache are 701 * mostly identical to the source. 702 */ 703 *dst = *src; 704 *dst_ses_cache = *src_ses_cache; 705 706 /* 707 * But the ses cache storage is still independent. Restore 708 * the pointer that was clobbered by the structure copy above. 709 */ 710 dst->private = dst_ses_cache; 711 712 /* 713 * The element map is independent even though it starts out 714 * pointing to the same constant page data. 715 */ 716 dst->elm_map = malloc(dst->nelms * sizeof(enc_element_t), 717 M_SCSIENC, M_WAITOK); 718 memcpy(dst->elm_map, src->elm_map, dst->nelms * sizeof(enc_element_t)); 719 for (dst_elm = dst->elm_map, src_elm = src->elm_map, 720 last_elm = &src->elm_map[src->nelms]; 721 src_elm != last_elm; src_elm++, dst_elm++) { 722 dst_elm->elm_private = malloc(sizeof(ses_element_t), 723 M_SCSIENC, M_WAITOK); 724 memcpy(dst_elm->elm_private, src_elm->elm_private, 725 sizeof(ses_element_t)); 726 } 727 } 728 729 /* Structure accessors. These are strongly typed to avoid errors. */ 730 731 int 732 ses_elm_sas_descr_type(union ses_elm_sas_hdr *obj) 733 { 734 return ((obj)->base_hdr.byte1 >> 6); 735 } 736 int 737 ses_elm_addlstatus_proto(struct ses_elm_addlstatus_base_hdr *hdr) 738 { 739 return ((hdr)->byte0 & 0xf); 740 } 741 int 742 ses_elm_addlstatus_eip(struct ses_elm_addlstatus_base_hdr *hdr) 743 { 744 return ((hdr)->byte0 >> 4 & 0x1); 745 } 746 int 747 ses_elm_addlstatus_invalid(struct ses_elm_addlstatus_base_hdr *hdr) 748 { 749 return ((hdr)->byte0 >> 7); 750 } 751 int 752 ses_elm_sas_type0_not_all_phys(union ses_elm_sas_hdr *hdr) 753 { 754 return ((hdr)->type0_noneip.byte1 & 0x1); 755 } 756 int 757 ses_elm_sas_dev_phy_sata_dev(struct ses_elm_sas_device_phy *phy) 758 { 759 return ((phy)->target_ports & 0x1); 760 } 761 int 762 ses_elm_sas_dev_phy_sata_port(struct ses_elm_sas_device_phy *phy) 763 { 764 return ((phy)->target_ports >> 7); 765 } 766 int 767 ses_elm_sas_dev_phy_dev_type(struct ses_elm_sas_device_phy *phy) 768 { 769 return (((phy)->byte0 >> 4) & 0x7); 770 } 771 772 /** 773 * \brief Verify that the cached configuration data in our softc 774 * is valid for processing the page data corresponding to 775 * the provided page header. 776 * 777 * \param ses_cache The SES cache to validate. 778 * \param gen_code The 4 byte generation code from a SES diagnostic 779 * page header. 780 * 781 * \return non-zero if true, 0 if false. 782 */ 783 static int 784 ses_config_cache_valid(ses_cache_t *ses_cache, const uint8_t *gen_code) 785 { 786 uint32_t cache_gc; 787 uint32_t cur_gc; 788 789 if (ses_cache->cfg_page == NULL) 790 return (0); 791 792 cache_gc = scsi_4btoul(ses_cache->cfg_page->hdr.gen_code); 793 cur_gc = scsi_4btoul(gen_code); 794 return (cache_gc == cur_gc); 795 } 796 797 /** 798 * Function signature for consumers of the ses_devids_iter() interface. 799 */ 800 typedef void ses_devid_callback_t(enc_softc_t *, enc_element_t *, 801 struct scsi_vpd_id_descriptor *, void *); 802 803 /** 804 * \brief Iterate over and create vpd device id records from the 805 * additional element status data for elm, passing that data 806 * to the provided callback. 807 * 808 * \param enc SES instance containing elm 809 * \param elm Element for which to extract device ID data. 810 * \param callback The callback function to invoke on each generated 811 * device id descriptor for elm. 812 * \param callback_arg Argument passed through to callback on each invocation. 813 */ 814 static void 815 ses_devids_iter(enc_softc_t *enc, enc_element_t *elm, 816 ses_devid_callback_t *callback, void *callback_arg) 817 { 818 ses_element_t *elmpriv; 819 struct ses_addl_status *addl; 820 u_int i; 821 size_t devid_record_size; 822 823 elmpriv = elm->elm_private; 824 addl = &(elmpriv->addl); 825 826 devid_record_size = SVPD_DEVICE_ID_DESC_HDR_LEN 827 + sizeof(struct scsi_vpd_id_naa_ieee_reg); 828 for (i = 0; i < addl->proto_hdr.sas->base_hdr.num_phys; i++) { 829 uint8_t devid_buf[devid_record_size]; 830 struct scsi_vpd_id_descriptor *devid; 831 uint8_t *phy_addr; 832 833 devid = (struct scsi_vpd_id_descriptor *)devid_buf; 834 phy_addr = addl->proto_data.sasdev_phys[i].phy_addr; 835 devid->proto_codeset = (SCSI_PROTO_SAS << SVPD_ID_PROTO_SHIFT) 836 | SVPD_ID_CODESET_BINARY; 837 devid->id_type = SVPD_ID_PIV 838 | SVPD_ID_ASSOC_PORT 839 | SVPD_ID_TYPE_NAA; 840 devid->reserved = 0; 841 devid->length = sizeof(struct scsi_vpd_id_naa_ieee_reg); 842 memcpy(devid->identifier, phy_addr, devid->length); 843 844 callback(enc, elm, devid, callback_arg); 845 } 846 } 847 848 /** 849 * Function signature for consumers of the ses_paths_iter() interface. 850 */ 851 typedef void ses_path_callback_t(enc_softc_t *, enc_element_t *, 852 struct cam_path *, void *); 853 854 /** 855 * Argument package passed through ses_devids_iter() by 856 * ses_paths_iter() to ses_path_iter_devid_callback(). 857 */ 858 typedef struct ses_path_iter_args { 859 ses_path_callback_t *callback; 860 void *callback_arg; 861 } ses_path_iter_args_t; 862 863 /** 864 * ses_devids_iter() callback function used by ses_paths_iter() 865 * to map device ids to peripheral driver instances. 866 * 867 * \param enc SES instance containing elm 868 * \param elm Element on which device ID matching is active. 869 * \param periph A device ID corresponding to elm. 870 * \param arg Argument passed through to callback on each invocation. 871 */ 872 static void 873 ses_path_iter_devid_callback(enc_softc_t *enc, enc_element_t *elem, 874 struct scsi_vpd_id_descriptor *devid, 875 void *arg) 876 { 877 struct ccb_dev_match cdm; 878 struct dev_match_pattern match_pattern; 879 struct dev_match_result match_result; 880 struct device_match_result *device_match; 881 struct device_match_pattern *device_pattern; 882 ses_path_iter_args_t *args; 883 struct cam_path *path; 884 885 args = (ses_path_iter_args_t *)arg; 886 match_pattern.type = DEV_MATCH_DEVICE; 887 device_pattern = &match_pattern.pattern.device_pattern; 888 device_pattern->flags = DEV_MATCH_DEVID; 889 device_pattern->data.devid_pat.id_len = 890 offsetof(struct scsi_vpd_id_descriptor, identifier) 891 + devid->length; 892 memcpy(device_pattern->data.devid_pat.id, devid, 893 device_pattern->data.devid_pat.id_len); 894 if (!ses_search_globally) { 895 device_pattern->flags |= DEV_MATCH_PATH; 896 device_pattern->path_id = xpt_path_path_id(enc->periph->path); 897 } 898 899 memset(&cdm, 0, sizeof(cdm)); 900 if (xpt_create_path(&cdm.ccb_h.path, /*periph*/NULL, 901 CAM_XPT_PATH_ID, 902 CAM_TARGET_WILDCARD, 903 CAM_LUN_WILDCARD) != CAM_REQ_CMP) 904 return; 905 906 cdm.ccb_h.func_code = XPT_DEV_MATCH; 907 cdm.num_patterns = 1; 908 cdm.patterns = &match_pattern; 909 cdm.pattern_buf_len = sizeof(match_pattern); 910 cdm.match_buf_len = sizeof(match_result); 911 cdm.matches = &match_result; 912 913 do { 914 xpt_action((union ccb *)&cdm); 915 916 if ((cdm.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP || 917 (cdm.status != CAM_DEV_MATCH_LAST && 918 cdm.status != CAM_DEV_MATCH_MORE) || 919 cdm.num_matches == 0) 920 break; 921 922 device_match = &match_result.result.device_result; 923 if (xpt_create_path(&path, /*periph*/NULL, 924 device_match->path_id, 925 device_match->target_id, 926 device_match->target_lun) == CAM_REQ_CMP) { 927 args->callback(enc, elem, path, args->callback_arg); 928 929 xpt_free_path(path); 930 } 931 } while (cdm.status == CAM_DEV_MATCH_MORE); 932 933 xpt_free_path(cdm.ccb_h.path); 934 } 935 936 /** 937 * \brief Iterate over and find the matching periph objects for the 938 * specified element. 939 * 940 * \param enc SES instance containing elm 941 * \param elm Element for which to perform periph object matching. 942 * \param callback The callback function to invoke with each matching 943 * periph object. 944 * \param callback_arg Argument passed through to callback on each invocation. 945 */ 946 static void 947 ses_paths_iter(enc_softc_t *enc, enc_element_t *elm, 948 ses_path_callback_t *callback, void *callback_arg) 949 { 950 ses_element_t *elmpriv; 951 struct ses_addl_status *addl; 952 953 elmpriv = elm->elm_private; 954 addl = &(elmpriv->addl); 955 956 if (addl->hdr == NULL) 957 return; 958 959 switch(ses_elm_addlstatus_proto(addl->hdr)) { 960 case SPSP_PROTO_SAS: 961 if (addl->proto_hdr.sas != NULL && 962 addl->proto_data.sasdev_phys != NULL) { 963 ses_path_iter_args_t args; 964 965 args.callback = callback; 966 args.callback_arg = callback_arg; 967 ses_devids_iter(enc, elm, ses_path_iter_devid_callback, 968 &args); 969 } 970 break; 971 case SPSP_PROTO_ATA: 972 if (addl->proto_hdr.ata != NULL) { 973 struct cam_path *path; 974 struct ccb_getdev cgd; 975 976 if (xpt_create_path(&path, /*periph*/NULL, 977 scsi_4btoul(addl->proto_hdr.ata->bus), 978 scsi_4btoul(addl->proto_hdr.ata->target), 0) 979 != CAM_REQ_CMP) 980 return; 981 982 xpt_gdev_type(&cgd, path); 983 if (cam_ccb_success((union ccb *)&cgd)) 984 callback(enc, elm, path, callback_arg); 985 986 xpt_free_path(path); 987 } 988 break; 989 } 990 } 991 992 /** 993 * ses_paths_iter() callback function used by ses_get_elmdevname() 994 * to record periph driver instance strings corresponding to a SES 995 * element. 996 * 997 * \param enc SES instance containing elm 998 * \param elm Element on which periph matching is active. 999 * \param periph A periph instance that matches elm. 1000 * \param arg Argument passed through to callback on each invocation. 1001 */ 1002 static void 1003 ses_elmdevname_callback(enc_softc_t *enc, enc_element_t *elem, 1004 struct cam_path *path, void *arg) 1005 { 1006 struct sbuf *sb; 1007 1008 sb = (struct sbuf *)arg; 1009 cam_periph_list(path, sb); 1010 } 1011 1012 /** 1013 * Argument package passed through ses_paths_iter() to 1014 * ses_getcampath_callback. 1015 */ 1016 typedef struct ses_setphyspath_callback_args { 1017 struct sbuf *physpath; 1018 int num_set; 1019 } ses_setphyspath_callback_args_t; 1020 1021 /** 1022 * \brief ses_paths_iter() callback to set the physical path on the 1023 * CAM EDT entries corresponding to a given SES element. 1024 * 1025 * \param enc SES instance containing elm 1026 * \param elm Element on which periph matching is active. 1027 * \param periph A periph instance that matches elm. 1028 * \param arg Argument passed through to callback on each invocation. 1029 */ 1030 static void 1031 ses_setphyspath_callback(enc_softc_t *enc, enc_element_t *elm, 1032 struct cam_path *path, void *arg) 1033 { 1034 struct ccb_dev_advinfo cdai; 1035 ses_setphyspath_callback_args_t *args; 1036 char *old_physpath; 1037 1038 args = (ses_setphyspath_callback_args_t *)arg; 1039 old_physpath = malloc(MAXPATHLEN, M_SCSIENC, M_WAITOK|M_ZERO); 1040 xpt_path_lock(path); 1041 memset(&cdai, 0, sizeof(cdai)); 1042 xpt_setup_ccb(&cdai.ccb_h, path, CAM_PRIORITY_NORMAL); 1043 cdai.ccb_h.func_code = XPT_DEV_ADVINFO; 1044 cdai.buftype = CDAI_TYPE_PHYS_PATH; 1045 cdai.flags = CDAI_FLAG_NONE; 1046 cdai.bufsiz = MAXPATHLEN; 1047 cdai.buf = old_physpath; 1048 xpt_action((union ccb *)&cdai); 1049 if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0) 1050 cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE); 1051 1052 if (strcmp(old_physpath, sbuf_data(args->physpath)) != 0) { 1053 xpt_setup_ccb(&cdai.ccb_h, path, CAM_PRIORITY_NORMAL); 1054 cdai.ccb_h.func_code = XPT_DEV_ADVINFO; 1055 cdai.buftype = CDAI_TYPE_PHYS_PATH; 1056 cdai.flags = CDAI_FLAG_STORE; 1057 cdai.bufsiz = sbuf_len(args->physpath); 1058 cdai.buf = sbuf_data(args->physpath); 1059 xpt_action((union ccb *)&cdai); 1060 if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0) 1061 cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE); 1062 if (cam_ccb_success((union ccb *)&cdai)) 1063 args->num_set++; 1064 } 1065 xpt_path_unlock(path); 1066 free(old_physpath, M_SCSIENC); 1067 } 1068 1069 /** 1070 * \brief Set a device's physical path string in CAM XPT. 1071 * 1072 * \param enc SES instance containing elm 1073 * \param elm Element to publish physical path string for 1074 * \param iter Iterator whose state corresponds to elm 1075 * 1076 * \return 0 on success, errno otherwise. 1077 */ 1078 static int 1079 ses_set_physpath(enc_softc_t *enc, enc_element_t *elm, 1080 struct ses_iterator *iter) 1081 { 1082 struct ccb_dev_advinfo cdai; 1083 ses_setphyspath_callback_args_t args; 1084 int i, ret; 1085 struct sbuf sb; 1086 struct scsi_vpd_id_descriptor *idd; 1087 uint8_t *devid; 1088 ses_element_t *elmpriv; 1089 const char *c; 1090 1091 ret = EIO; 1092 devid = NULL; 1093 1094 elmpriv = elm->elm_private; 1095 if (elmpriv->addl.hdr == NULL) 1096 goto out; 1097 1098 /* 1099 * Assemble the components of the physical path starting with 1100 * the device ID of the enclosure itself. 1101 */ 1102 memset(&cdai, 0, sizeof(cdai)); 1103 xpt_setup_ccb(&cdai.ccb_h, enc->periph->path, CAM_PRIORITY_NORMAL); 1104 cdai.ccb_h.func_code = XPT_DEV_ADVINFO; 1105 cdai.flags = CDAI_FLAG_NONE; 1106 cdai.buftype = CDAI_TYPE_SCSI_DEVID; 1107 cdai.bufsiz = CAM_SCSI_DEVID_MAXLEN; 1108 cdai.buf = devid = malloc(cdai.bufsiz, M_SCSIENC, M_WAITOK|M_ZERO); 1109 cam_periph_lock(enc->periph); 1110 xpt_action((union ccb *)&cdai); 1111 if ((cdai.ccb_h.status & CAM_DEV_QFRZN) != 0) 1112 cam_release_devq(cdai.ccb_h.path, 0, 0, 0, FALSE); 1113 cam_periph_unlock(enc->periph); 1114 if (cdai.ccb_h.status != CAM_REQ_CMP) 1115 goto out; 1116 1117 idd = scsi_get_devid((struct scsi_vpd_device_id *)cdai.buf, 1118 cdai.provsiz, scsi_devid_is_naa_ieee_reg); 1119 if (idd == NULL) 1120 goto out; 1121 1122 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL) { 1123 ret = ENOMEM; 1124 goto out; 1125 } 1126 /* Next, generate the physical path string */ 1127 sbuf_printf(&sb, "id1,enc@n%jx/type@%x/slot@%x", 1128 scsi_8btou64(idd->identifier), iter->type_index, 1129 iter->type_element_index); 1130 /* Append the element descriptor if one exists */ 1131 if (elmpriv->descr != NULL && elmpriv->descr_len > 0) { 1132 sbuf_cat(&sb, "/elmdesc@"); 1133 for (i = 0, c = elmpriv->descr; i < elmpriv->descr_len; 1134 i++, c++) { 1135 if (!isprint(*c) || isspace(*c) || *c == '/') 1136 sbuf_putc(&sb, '_'); 1137 else 1138 sbuf_putc(&sb, *c); 1139 } 1140 } 1141 sbuf_finish(&sb); 1142 1143 /* 1144 * Set this physical path on any CAM devices with a device ID 1145 * descriptor that matches one created from the SES additional 1146 * status data for this element. 1147 */ 1148 args.physpath= &sb; 1149 args.num_set = 0; 1150 ses_paths_iter(enc, elm, ses_setphyspath_callback, &args); 1151 sbuf_delete(&sb); 1152 1153 ret = args.num_set == 0 ? ENOENT : 0; 1154 1155 out: 1156 if (devid != NULL) 1157 ENC_FREE(devid); 1158 return (ret); 1159 } 1160 1161 /** 1162 * \brief Helper to set the CDB fields appropriately. 1163 * 1164 * \param cdb Buffer containing the cdb. 1165 * \param pagenum SES diagnostic page to query for. 1166 * \param dir Direction of query. 1167 */ 1168 static void 1169 ses_page_cdb(char *cdb, int bufsiz, SesDiagPageCodes pagenum, int dir) 1170 { 1171 1172 /* Ref: SPC-4 r25 Section 6.20 Table 223 */ 1173 if (dir == CAM_DIR_IN) { 1174 cdb[0] = RECEIVE_DIAGNOSTIC; 1175 cdb[1] = 1; /* Set page code valid bit */ 1176 cdb[2] = pagenum; 1177 } else { 1178 cdb[0] = SEND_DIAGNOSTIC; 1179 cdb[1] = 0x10; 1180 cdb[2] = pagenum; 1181 } 1182 cdb[3] = bufsiz >> 8; /* high bits */ 1183 cdb[4] = bufsiz & 0xff; /* low bits */ 1184 cdb[5] = 0; 1185 } 1186 1187 /** 1188 * \brief Discover whether this instance supports timed completion of a 1189 * RECEIVE DIAGNOSTIC RESULTS command requesting the Enclosure Status 1190 * page, and store the result in the softc, updating if necessary. 1191 * 1192 * \param enc SES instance to query and update. 1193 * \param tc_en Value of timed completion to set (see \return). 1194 * 1195 * \return 1 if timed completion enabled, 0 otherwise. 1196 */ 1197 static int 1198 ses_set_timed_completion(enc_softc_t *enc, uint8_t tc_en) 1199 { 1200 union ccb *ccb; 1201 struct cam_periph *periph; 1202 struct ses_mgmt_mode_page *mgmt; 1203 uint8_t *mode_buf; 1204 size_t mode_buf_len; 1205 ses_softc_t *ses; 1206 1207 periph = enc->periph; 1208 ses = enc->enc_private; 1209 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL); 1210 1211 mode_buf_len = sizeof(struct ses_mgmt_mode_page); 1212 mode_buf = ENC_MALLOCZ(mode_buf_len); 1213 if (mode_buf == NULL) 1214 goto out; 1215 1216 scsi_mode_sense(&ccb->csio, /*retries*/4, NULL, MSG_SIMPLE_Q_TAG, 1217 /*dbd*/FALSE, SMS_PAGE_CTRL_CURRENT, SES_MGMT_MODE_PAGE_CODE, 1218 mode_buf, mode_buf_len, SSD_FULL_SIZE, /*timeout*/60 * 1000); 1219 1220 /* 1221 * Ignore illegal request errors, as they are quite common and we 1222 * will print something out in that case anyway. 1223 */ 1224 cam_periph_runccb(ccb, enc_error, ENC_CFLAGS, 1225 ENC_FLAGS|SF_QUIET_IR, NULL); 1226 if (ccb->ccb_h.status != CAM_REQ_CMP) { 1227 ENC_VLOG(enc, "Timed Completion Unsupported\n"); 1228 goto release; 1229 } 1230 1231 /* Skip the mode select if the desired value is already set */ 1232 mgmt = (struct ses_mgmt_mode_page *)mode_buf; 1233 if ((mgmt->byte5 & SES_MGMT_TIMED_COMP_EN) == tc_en) 1234 goto done; 1235 1236 /* Value is not what we wanted, set it */ 1237 if (tc_en) 1238 mgmt->byte5 |= SES_MGMT_TIMED_COMP_EN; 1239 else 1240 mgmt->byte5 &= ~SES_MGMT_TIMED_COMP_EN; 1241 /* SES2r20: a completion time of zero means as long as possible */ 1242 bzero(&mgmt->max_comp_time, sizeof(mgmt->max_comp_time)); 1243 1244 scsi_mode_select(&ccb->csio, 5, NULL, MSG_SIMPLE_Q_TAG, 1245 /*page_fmt*/FALSE, /*save_pages*/TRUE, mode_buf, mode_buf_len, 1246 SSD_FULL_SIZE, /*timeout*/60 * 1000); 1247 1248 cam_periph_runccb(ccb, enc_error, ENC_CFLAGS, ENC_FLAGS, NULL); 1249 if (ccb->ccb_h.status != CAM_REQ_CMP) { 1250 ENC_VLOG(enc, "Timed Completion Set Failed\n"); 1251 goto release; 1252 } 1253 1254 done: 1255 if ((mgmt->byte5 & SES_MGMT_TIMED_COMP_EN) != 0) { 1256 ENC_LOG(enc, "Timed Completion Enabled\n"); 1257 ses->ses_flags |= SES_FLAG_TIMEDCOMP; 1258 } else { 1259 ENC_LOG(enc, "Timed Completion Disabled\n"); 1260 ses->ses_flags &= ~SES_FLAG_TIMEDCOMP; 1261 } 1262 release: 1263 ENC_FREE(mode_buf); 1264 xpt_release_ccb(ccb); 1265 out: 1266 return (ses->ses_flags & SES_FLAG_TIMEDCOMP); 1267 } 1268 1269 /** 1270 * \brief Process the list of supported pages and update flags. 1271 * 1272 * \param enc SES device to query. 1273 * \param buf Buffer containing the config page. 1274 * \param xfer_len Length of the config page in the buffer. 1275 * 1276 * \return 0 on success, errno otherwise. 1277 */ 1278 static int 1279 ses_process_pages(enc_softc_t *enc, struct enc_fsm_state *state, 1280 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1281 { 1282 ses_softc_t *ses; 1283 struct scsi_diag_page *page; 1284 int err, i, length; 1285 1286 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE, 1287 ("entering %s(%p, %d)\n", __func__, bufp, xfer_len)); 1288 ses = enc->enc_private; 1289 err = -1; 1290 1291 if (error != 0) { 1292 err = error; 1293 goto out; 1294 } 1295 if (xfer_len < sizeof(*page)) { 1296 ENC_VLOG(enc, "Unable to parse Diag Pages List Header\n"); 1297 err = EIO; 1298 goto out; 1299 } 1300 page = (struct scsi_diag_page *)*bufp; 1301 length = scsi_2btoul(page->length); 1302 if (length + offsetof(struct scsi_diag_page, params) > xfer_len) { 1303 ENC_VLOG(enc, "Diag Pages List Too Long\n"); 1304 goto out; 1305 } 1306 ENC_DLOG(enc, "%s: page length %d, xfer_len %d\n", 1307 __func__, length, xfer_len); 1308 1309 err = 0; 1310 for (i = 0; i < length; i++) { 1311 if (page->params[i] == SesElementDescriptor) 1312 ses->ses_flags |= SES_FLAG_DESC; 1313 else if (page->params[i] == SesAddlElementStatus) 1314 ses->ses_flags |= SES_FLAG_ADDLSTATUS; 1315 } 1316 1317 out: 1318 ENC_DLOG(enc, "%s: exiting with err %d\n", __func__, err); 1319 return (err); 1320 } 1321 1322 /** 1323 * \brief Process the config page and update associated structures. 1324 * 1325 * \param enc SES device to query. 1326 * \param buf Buffer containing the config page. 1327 * \param xfer_len Length of the config page in the buffer. 1328 * 1329 * \return 0 on success, errno otherwise. 1330 */ 1331 static int 1332 ses_process_config(enc_softc_t *enc, struct enc_fsm_state *state, 1333 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1334 { 1335 struct ses_iterator iter; 1336 enc_cache_t *enc_cache; 1337 ses_cache_t *ses_cache; 1338 uint8_t *buf; 1339 int length; 1340 int err; 1341 int nelm; 1342 int ntype; 1343 struct ses_cfg_page *cfg_page; 1344 struct ses_enc_desc *buf_subenc; 1345 const struct ses_enc_desc **subencs; 1346 const struct ses_enc_desc **cur_subenc; 1347 const struct ses_enc_desc **last_subenc; 1348 ses_type_t *ses_types; 1349 ses_type_t *sestype; 1350 const struct ses_elm_type_desc *cur_buf_type; 1351 const struct ses_elm_type_desc *last_buf_type; 1352 uint8_t *last_valid_byte; 1353 enc_element_t *element; 1354 const char *type_text; 1355 1356 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE, 1357 ("entering %s(%p, %d)\n", __func__, bufp, xfer_len)); 1358 enc_cache = &enc->enc_daemon_cache; 1359 ses_cache = enc_cache->private; 1360 buf = *bufp; 1361 err = -1; 1362 1363 if (error != 0) { 1364 err = error; 1365 goto out; 1366 } 1367 if (xfer_len < sizeof(cfg_page->hdr)) { 1368 ENC_VLOG(enc, "Unable to parse SES Config Header\n"); 1369 err = EIO; 1370 goto out; 1371 } 1372 1373 cfg_page = (struct ses_cfg_page *)buf; 1374 length = ses_page_length(&cfg_page->hdr); 1375 if (length > xfer_len) { 1376 ENC_VLOG(enc, "Enclosure Config Page Too Long\n"); 1377 goto out; 1378 } 1379 last_valid_byte = &buf[length - 1]; 1380 1381 ENC_DLOG(enc, "%s: total page length %d, xfer_len %d\n", 1382 __func__, length, xfer_len); 1383 1384 err = 0; 1385 if (ses_config_cache_valid(ses_cache, cfg_page->hdr.gen_code)) { 1386 /* Our cache is still valid. Proceed to fetching status. */ 1387 goto out; 1388 } 1389 1390 /* Cache is no longer valid. Free old data to make way for new. */ 1391 ses_cache_free(enc, enc_cache); 1392 ENC_VLOG(enc, "Generation Code 0x%x has %d SubEnclosures\n", 1393 scsi_4btoul(cfg_page->hdr.gen_code), 1394 ses_cfg_page_get_num_subenc(cfg_page)); 1395 1396 /* Take ownership of the buffer. */ 1397 ses_cache->cfg_page = cfg_page; 1398 *bufp = NULL; 1399 1400 /* 1401 * Now waltz through all the subenclosures summing the number of 1402 * types available in each. 1403 */ 1404 subencs = malloc(ses_cfg_page_get_num_subenc(cfg_page) 1405 * sizeof(*subencs), M_SCSIENC, M_WAITOK|M_ZERO); 1406 /* 1407 * Sub-enclosure data is const after construction (i.e. when 1408 * accessed via our cache object. 1409 * 1410 * The cast here is not required in C++ but C99 is not so 1411 * sophisticated (see C99 6.5.16.1(1)). 1412 */ 1413 ses_cache->ses_nsubencs = ses_cfg_page_get_num_subenc(cfg_page); 1414 ses_cache->subencs = subencs; 1415 1416 buf_subenc = cfg_page->subencs; 1417 cur_subenc = subencs; 1418 last_subenc = &subencs[ses_cache->ses_nsubencs - 1]; 1419 ntype = 0; 1420 while (cur_subenc <= last_subenc) { 1421 if (!ses_enc_desc_is_complete(buf_subenc, last_valid_byte)) { 1422 ENC_VLOG(enc, "Enclosure %d Beyond End of " 1423 "Descriptors\n", cur_subenc - subencs); 1424 err = EIO; 1425 goto out; 1426 } 1427 1428 ENC_VLOG(enc, " SubEnclosure ID %d, %d Types With this ID, " 1429 "Descriptor Length %d, offset %d\n", buf_subenc->subenc_id, 1430 buf_subenc->num_types, buf_subenc->length, 1431 &buf_subenc->byte0 - buf); 1432 ENC_VLOG(enc, "WWN: %jx\n", 1433 (uintmax_t)scsi_8btou64(buf_subenc->logical_id)); 1434 1435 ntype += buf_subenc->num_types; 1436 *cur_subenc = buf_subenc; 1437 cur_subenc++; 1438 buf_subenc = ses_enc_desc_next(buf_subenc); 1439 } 1440 1441 /* Process the type headers. */ 1442 ses_types = malloc(ntype * sizeof(*ses_types), 1443 M_SCSIENC, M_WAITOK|M_ZERO); 1444 /* 1445 * Type data is const after construction (i.e. when accessed via 1446 * our cache object. 1447 */ 1448 ses_cache->ses_ntypes = ntype; 1449 ses_cache->ses_types = ses_types; 1450 1451 cur_buf_type = (const struct ses_elm_type_desc *) 1452 (&(*last_subenc)->length + (*last_subenc)->length + 1); 1453 last_buf_type = cur_buf_type + ntype - 1; 1454 type_text = (const uint8_t *)(last_buf_type + 1); 1455 nelm = 0; 1456 sestype = ses_types; 1457 while (cur_buf_type <= last_buf_type) { 1458 if (&cur_buf_type->etype_txt_len > last_valid_byte) { 1459 ENC_VLOG(enc, "Runt Enclosure Type Header %d\n", 1460 sestype - ses_types); 1461 err = EIO; 1462 goto out; 1463 } 1464 sestype->hdr = cur_buf_type; 1465 sestype->text = type_text; 1466 type_text += cur_buf_type->etype_txt_len; 1467 ENC_VLOG(enc, " Type Desc[%d]: Type 0x%x, MaxElt %d, In Subenc " 1468 "%d, Text Length %d: %.*s\n", sestype - ses_types, 1469 sestype->hdr->etype_elm_type, sestype->hdr->etype_maxelt, 1470 sestype->hdr->etype_subenc, sestype->hdr->etype_txt_len, 1471 sestype->hdr->etype_txt_len, sestype->text); 1472 1473 nelm += sestype->hdr->etype_maxelt 1474 + /*overall status element*/1; 1475 sestype++; 1476 cur_buf_type++; 1477 } 1478 1479 /* Create the object map. */ 1480 enc_cache->elm_map = malloc(nelm * sizeof(enc_element_t), 1481 M_SCSIENC, M_WAITOK|M_ZERO); 1482 enc_cache->nelms = nelm; 1483 1484 ses_iter_init(enc, enc_cache, &iter); 1485 while ((element = ses_iter_next(&iter)) != NULL) { 1486 const struct ses_elm_type_desc *thdr; 1487 1488 ENC_DLOG(enc, "%s: checking obj %d(%d,%d)\n", __func__, 1489 iter.global_element_index, iter.type_index, nelm, 1490 iter.type_element_index); 1491 thdr = ses_cache->ses_types[iter.type_index].hdr; 1492 element->elm_idx = iter.global_element_index; 1493 element->elm_type = thdr->etype_elm_type; 1494 element->subenclosure = thdr->etype_subenc; 1495 element->type_elm_idx = iter.type_element_index; 1496 element->elm_private = malloc(sizeof(ses_element_t), 1497 M_SCSIENC, M_WAITOK|M_ZERO); 1498 ENC_DLOG(enc, "%s: creating elmpriv %d(%d,%d) subenc %d " 1499 "type 0x%x\n", __func__, iter.global_element_index, 1500 iter.type_index, iter.type_element_index, 1501 thdr->etype_subenc, thdr->etype_elm_type); 1502 } 1503 1504 err = 0; 1505 1506 out: 1507 if (err) 1508 ses_cache_free(enc, enc_cache); 1509 else { 1510 ses_poll_status(enc); 1511 enc_update_request(enc, SES_PUBLISH_CACHE); 1512 } 1513 ENC_DLOG(enc, "%s: exiting with err %d\n", __func__, err); 1514 return (err); 1515 } 1516 1517 /** 1518 * \brief Update the status page and associated structures. 1519 * 1520 * \param enc SES softc to update for. 1521 * \param buf Buffer containing the status page. 1522 * \param bufsz Amount of data in the buffer. 1523 * 1524 * \return 0 on success, errno otherwise. 1525 */ 1526 static int 1527 ses_process_status(enc_softc_t *enc, struct enc_fsm_state *state, 1528 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1529 { 1530 struct ses_iterator iter; 1531 enc_element_t *element; 1532 ses_softc_t *ses; 1533 enc_cache_t *enc_cache; 1534 ses_cache_t *ses_cache; 1535 uint8_t *buf; 1536 int err = -1; 1537 int length; 1538 struct ses_status_page *page; 1539 union ses_status_element *cur_stat; 1540 union ses_status_element *last_stat; 1541 1542 ses = enc->enc_private; 1543 enc_cache = &enc->enc_daemon_cache; 1544 ses_cache = enc_cache->private; 1545 buf = *bufp; 1546 1547 ENC_DLOG(enc, "%s: enter (%p, %p, %d)\n", __func__, enc, buf, xfer_len); 1548 page = (struct ses_status_page *)buf; 1549 length = ses_page_length(&page->hdr); 1550 1551 if (error != 0) { 1552 err = error; 1553 goto out; 1554 } 1555 /* 1556 * Make sure the length fits in the buffer. 1557 * 1558 * XXX all this means is that the page is larger than the space 1559 * we allocated. Since we use a statically sized buffer, this 1560 * could happen... Need to use dynamic discovery of the size. 1561 */ 1562 if (length > xfer_len) { 1563 ENC_VLOG(enc, "Enclosure Status Page Too Long\n"); 1564 goto out; 1565 } 1566 1567 /* Check for simple enclosure reporting short enclosure status. */ 1568 if (length >= 4 && page->hdr.page_code == SesShortStatus) { 1569 ENC_DLOG(enc, "Got Short Enclosure Status page\n"); 1570 ses->ses_flags &= ~(SES_FLAG_ADDLSTATUS | SES_FLAG_DESC); 1571 ses_cache_free(enc, enc_cache); 1572 enc_cache->enc_status = page->hdr.page_specific_flags; 1573 enc_update_request(enc, SES_PUBLISH_CACHE); 1574 err = 0; 1575 goto out; 1576 } 1577 1578 /* Make sure the length contains at least one header and status */ 1579 if (length < (sizeof(*page) + sizeof(*page->elements))) { 1580 ENC_VLOG(enc, "Enclosure Status Page Too Short\n"); 1581 goto out; 1582 } 1583 1584 if (!ses_config_cache_valid(ses_cache, page->hdr.gen_code)) { 1585 ENC_DLOG(enc, "%s: Generation count change detected\n", 1586 __func__); 1587 enc_update_request(enc, SES_UPDATE_GETCONFIG); 1588 goto out; 1589 } 1590 1591 ses_cache_free_status(enc, enc_cache); 1592 ses_cache->status_page = page; 1593 *bufp = NULL; 1594 1595 enc_cache->enc_status = page->hdr.page_specific_flags; 1596 1597 /* 1598 * Read in individual element status. The element order 1599 * matches the order reported in the config page (i.e. the 1600 * order of an unfiltered iteration of the config objects).. 1601 */ 1602 ses_iter_init(enc, enc_cache, &iter); 1603 cur_stat = page->elements; 1604 last_stat = (union ses_status_element *) 1605 &buf[length - sizeof(*last_stat)]; 1606 ENC_DLOG(enc, "%s: total page length %d, xfer_len %d\n", 1607 __func__, length, xfer_len); 1608 while (cur_stat <= last_stat 1609 && (element = ses_iter_next(&iter)) != NULL) { 1610 ENC_DLOG(enc, "%s: obj %d(%d,%d) off=0x%tx status=%jx\n", 1611 __func__, iter.global_element_index, iter.type_index, 1612 iter.type_element_index, (uint8_t *)cur_stat - buf, 1613 scsi_4btoul(cur_stat->bytes)); 1614 1615 memcpy(&element->encstat, cur_stat, sizeof(element->encstat)); 1616 element->svalid = 1; 1617 cur_stat++; 1618 } 1619 1620 if (ses_iter_next(&iter) != NULL) { 1621 ENC_VLOG(enc, "Status page, length insufficient for " 1622 "expected number of objects\n"); 1623 } else { 1624 if (cur_stat <= last_stat) 1625 ENC_VLOG(enc, "Status page, exhausted objects before " 1626 "exhausing page\n"); 1627 enc_update_request(enc, SES_PUBLISH_CACHE); 1628 err = 0; 1629 } 1630 out: 1631 ENC_DLOG(enc, "%s: exiting with error %d\n", __func__, err); 1632 return (err); 1633 } 1634 1635 typedef enum { 1636 /** 1637 * The enclosure should not provide additional element 1638 * status for this element type in page 0x0A. 1639 * 1640 * \note This status is returned for any types not 1641 * listed SES3r02. Further types added in a 1642 * future specification will be incorrectly 1643 * classified. 1644 */ 1645 TYPE_ADDLSTATUS_NONE, 1646 1647 /** 1648 * The element type provides additional element status 1649 * in page 0x0A. 1650 */ 1651 TYPE_ADDLSTATUS_MANDATORY, 1652 1653 /** 1654 * The element type may provide additional element status 1655 * in page 0x0A, but i 1656 */ 1657 TYPE_ADDLSTATUS_OPTIONAL 1658 } ses_addlstatus_avail_t; 1659 1660 /** 1661 * \brief Check to see whether a given type (as obtained via type headers) is 1662 * supported by the additional status command. 1663 * 1664 * \param enc SES softc to check. 1665 * \param typidx Type index to check for. 1666 * 1667 * \return An enumeration indicating if additional status is mandatory, 1668 * optional, or not required for this type. 1669 */ 1670 static ses_addlstatus_avail_t 1671 ses_typehasaddlstatus(enc_softc_t *enc, uint8_t typidx) 1672 { 1673 enc_cache_t *enc_cache; 1674 ses_cache_t *ses_cache; 1675 1676 enc_cache = &enc->enc_daemon_cache; 1677 ses_cache = enc_cache->private; 1678 switch(ses_cache->ses_types[typidx].hdr->etype_elm_type) { 1679 case ELMTYP_DEVICE: 1680 case ELMTYP_ARRAY_DEV: 1681 case ELMTYP_SAS_EXP: 1682 return (TYPE_ADDLSTATUS_MANDATORY); 1683 case ELMTYP_SCSI_INI: 1684 case ELMTYP_SCSI_TGT: 1685 case ELMTYP_ESCC: 1686 return (TYPE_ADDLSTATUS_OPTIONAL); 1687 default: 1688 /* No additional status information available. */ 1689 break; 1690 } 1691 return (TYPE_ADDLSTATUS_NONE); 1692 } 1693 1694 static int ses_get_elm_addlstatus_fc(enc_softc_t *, enc_cache_t *, 1695 uint8_t *, int); 1696 static int ses_get_elm_addlstatus_sas(enc_softc_t *, enc_cache_t *, uint8_t *, 1697 int, int, int, int); 1698 static int ses_get_elm_addlstatus_ata(enc_softc_t *, enc_cache_t *, uint8_t *, 1699 int, int, int, int); 1700 1701 /** 1702 * \brief Parse the additional status element data for each object. 1703 * 1704 * \param enc The SES softc to update. 1705 * \param buf The buffer containing the additional status 1706 * element response. 1707 * \param xfer_len Size of the buffer. 1708 * 1709 * \return 0 on success, errno otherwise. 1710 */ 1711 static int 1712 ses_process_elm_addlstatus(enc_softc_t *enc, struct enc_fsm_state *state, 1713 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1714 { 1715 struct ses_iterator iter, titer; 1716 int eip; 1717 int err; 1718 int length; 1719 int offset; 1720 enc_cache_t *enc_cache; 1721 ses_cache_t *ses_cache; 1722 uint8_t *buf; 1723 ses_element_t *elmpriv; 1724 const struct ses_page_hdr *hdr; 1725 enc_element_t *element, *telement; 1726 1727 enc_cache = &enc->enc_daemon_cache; 1728 ses_cache = enc_cache->private; 1729 buf = *bufp; 1730 err = -1; 1731 1732 if (error != 0) { 1733 err = error; 1734 goto out; 1735 } 1736 ses_cache_free_elm_addlstatus(enc, enc_cache); 1737 ses_cache->elm_addlstatus_page = 1738 (struct ses_addl_elem_status_page *)buf; 1739 *bufp = NULL; 1740 1741 /* 1742 * The objects appear in the same order here as in Enclosure Status, 1743 * which itself is ordered by the Type Descriptors from the Config 1744 * page. However, it is necessary to skip elements that are not 1745 * supported by this page when counting them. 1746 */ 1747 hdr = &ses_cache->elm_addlstatus_page->hdr; 1748 length = ses_page_length(hdr); 1749 ENC_DLOG(enc, "Additional Element Status Page Length 0x%x\n", length); 1750 /* Make sure the length includes at least one header. */ 1751 if (length < sizeof(*hdr)+sizeof(struct ses_elm_addlstatus_base_hdr)) { 1752 ENC_VLOG(enc, "Runt Additional Element Status Page\n"); 1753 goto out; 1754 } 1755 if (length > xfer_len) { 1756 ENC_VLOG(enc, "Additional Element Status Page Too Long\n"); 1757 goto out; 1758 } 1759 1760 if (!ses_config_cache_valid(ses_cache, hdr->gen_code)) { 1761 ENC_DLOG(enc, "%s: Generation count change detected\n", 1762 __func__); 1763 enc_update_request(enc, SES_UPDATE_GETCONFIG); 1764 goto out; 1765 } 1766 1767 offset = sizeof(struct ses_page_hdr); 1768 ses_iter_init(enc, enc_cache, &iter); 1769 while (offset < length 1770 && (element = ses_iter_next(&iter)) != NULL) { 1771 struct ses_elm_addlstatus_base_hdr *elm_hdr; 1772 int proto_info_len; 1773 ses_addlstatus_avail_t status_type; 1774 1775 /* 1776 * Additional element status is only provided for 1777 * individual elements (i.e. overal status elements 1778 * are excluded) and those of the types specified 1779 * in the SES spec. 1780 */ 1781 status_type = ses_typehasaddlstatus(enc, iter.type_index); 1782 if (iter.individual_element_index == ITERATOR_INDEX_INVALID 1783 || status_type == TYPE_ADDLSTATUS_NONE) 1784 continue; 1785 1786 elm_hdr = (struct ses_elm_addlstatus_base_hdr *)&buf[offset]; 1787 eip = ses_elm_addlstatus_eip(elm_hdr); 1788 if (eip) { 1789 struct ses_elm_addlstatus_eip_hdr *eip_hdr; 1790 int expected_index, index; 1791 ses_elem_index_type_t index_type; 1792 1793 eip_hdr = (struct ses_elm_addlstatus_eip_hdr *)elm_hdr; 1794 if (SES_ADDL_EIP_EIIOE_EI_GLOB(eip_hdr->byte2)) { 1795 index_type = SES_ELEM_INDEX_GLOBAL; 1796 expected_index = iter.global_element_index; 1797 } else { 1798 index_type = SES_ELEM_INDEX_INDIVIDUAL; 1799 expected_index = iter.individual_element_index; 1800 } 1801 if (eip_hdr->element_index < expected_index) { 1802 ENC_VLOG(enc, "%s: provided %selement index " 1803 "%d is lower then expected %d\n", 1804 __func__, SES_ADDL_EIP_EIIOE_EI_GLOB( 1805 eip_hdr->byte2) ? "global " : "", 1806 eip_hdr->element_index, expected_index); 1807 goto badindex; 1808 } 1809 titer = iter; 1810 telement = ses_iter_seek_to(&titer, 1811 eip_hdr->element_index, index_type); 1812 if (telement == NULL) { 1813 ENC_VLOG(enc, "%s: provided %selement index " 1814 "%d does not exist\n", __func__, 1815 SES_ADDL_EIP_EIIOE_EI_GLOB(eip_hdr->byte2) ? 1816 "global " : "", eip_hdr->element_index); 1817 goto badindex; 1818 } 1819 if (ses_typehasaddlstatus(enc, titer.type_index) == 1820 TYPE_ADDLSTATUS_NONE) { 1821 ENC_VLOG(enc, "%s: provided %selement index " 1822 "%d can't have additional status\n", 1823 __func__, 1824 SES_ADDL_EIP_EIIOE_EI_GLOB(eip_hdr->byte2) ? 1825 "global " : "", eip_hdr->element_index); 1826 badindex: 1827 /* 1828 * If we expected mandatory element, we may 1829 * guess it was just a wrong index and we may 1830 * use the status. If element was optional, 1831 * then we have no idea where status belongs. 1832 */ 1833 if (status_type == TYPE_ADDLSTATUS_OPTIONAL) 1834 break; 1835 } else { 1836 iter = titer; 1837 element = telement; 1838 } 1839 1840 if (SES_ADDL_EIP_EIIOE_EI_GLOB(eip_hdr->byte2)) 1841 index = iter.global_element_index; 1842 else 1843 index = iter.individual_element_index; 1844 if (index > expected_index 1845 && status_type == TYPE_ADDLSTATUS_MANDATORY) { 1846 ENC_VLOG(enc, "%s: provided %s element" 1847 "index %d skips mandatory status " 1848 " element at index %d\n", 1849 __func__, SES_ADDL_EIP_EIIOE_EI_GLOB( 1850 eip_hdr->byte2) ? "global " : "", 1851 index, expected_index); 1852 } 1853 } 1854 elmpriv = element->elm_private; 1855 ENC_DLOG(enc, "%s: global element index=%d, type index=%d " 1856 "type element index=%d, offset=0x%x, " 1857 "byte0=0x%x, length=0x%x\n", __func__, 1858 iter.global_element_index, iter.type_index, 1859 iter.type_element_index, offset, elm_hdr->byte0, 1860 elm_hdr->length); 1861 1862 /* Skip to after the length field */ 1863 offset += sizeof(struct ses_elm_addlstatus_base_hdr); 1864 1865 /* Make sure the descriptor is within bounds */ 1866 if ((offset + elm_hdr->length) > length) { 1867 ENC_VLOG(enc, "Element %d Beyond End " 1868 "of Additional Element Status Descriptors\n", 1869 iter.global_element_index); 1870 break; 1871 } 1872 1873 /* Skip elements marked as invalid. */ 1874 if (ses_elm_addlstatus_invalid(elm_hdr)) { 1875 offset += elm_hdr->length; 1876 continue; 1877 } 1878 elmpriv->addl.hdr = elm_hdr; 1879 1880 /* Advance to the protocol data, skipping eip bytes if needed */ 1881 offset += (eip * SES_EIP_HDR_EXTRA_LEN); 1882 proto_info_len = elm_hdr->length 1883 - (eip * SES_EIP_HDR_EXTRA_LEN); 1884 1885 /* Errors in this block are ignored as they are non-fatal */ 1886 switch(ses_elm_addlstatus_proto(elm_hdr)) { 1887 case SPSP_PROTO_FC: 1888 if (elm_hdr->length == 0) 1889 break; 1890 ses_get_elm_addlstatus_fc(enc, enc_cache, 1891 &buf[offset], proto_info_len); 1892 break; 1893 case SPSP_PROTO_SAS: 1894 if (elm_hdr->length <= 2) 1895 break; 1896 ses_get_elm_addlstatus_sas(enc, enc_cache, 1897 &buf[offset], 1898 proto_info_len, 1899 eip, iter.type_index, 1900 iter.global_element_index); 1901 break; 1902 case SPSP_PROTO_ATA: 1903 ses_get_elm_addlstatus_ata(enc, enc_cache, 1904 &buf[offset], 1905 proto_info_len, 1906 eip, iter.type_index, 1907 iter.global_element_index); 1908 break; 1909 default: 1910 ENC_VLOG(enc, "Element %d: Unknown Additional Element " 1911 "Protocol 0x%x\n", iter.global_element_index, 1912 ses_elm_addlstatus_proto(elm_hdr)); 1913 break; 1914 } 1915 1916 offset += proto_info_len; 1917 } 1918 err = 0; 1919 out: 1920 if (err) 1921 ses_cache_free_elm_addlstatus(enc, enc_cache); 1922 enc_update_request(enc, SES_PUBLISH_PHYSPATHS); 1923 enc_update_request(enc, SES_PUBLISH_CACHE); 1924 return (err); 1925 } 1926 1927 static int 1928 ses_process_control_request(enc_softc_t *enc, struct enc_fsm_state *state, 1929 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1930 { 1931 ses_softc_t *ses; 1932 1933 ses = enc->enc_private; 1934 /* 1935 * Possible errors: 1936 * o Generation count wrong. 1937 * o Some SCSI status error. 1938 */ 1939 ses_terminate_control_requests(&ses->ses_pending_requests, error); 1940 ses_poll_status(enc); 1941 return (0); 1942 } 1943 1944 static int 1945 ses_publish_physpaths(enc_softc_t *enc, struct enc_fsm_state *state, 1946 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1947 { 1948 struct ses_iterator iter; 1949 enc_cache_t *enc_cache; 1950 enc_element_t *element; 1951 1952 enc_cache = &enc->enc_daemon_cache; 1953 1954 ses_iter_init(enc, enc_cache, &iter); 1955 while ((element = ses_iter_next(&iter)) != NULL) { 1956 /* 1957 * ses_set_physpath() returns success if we changed 1958 * the physpath of any element. This allows us to 1959 * only announce devices once regardless of how 1960 * many times we process additional element status. 1961 */ 1962 if (ses_set_physpath(enc, element, &iter) == 0) 1963 ses_print_addl_data(enc, element); 1964 } 1965 1966 return (0); 1967 } 1968 1969 static int 1970 ses_publish_cache(enc_softc_t *enc, struct enc_fsm_state *state, 1971 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 1972 { 1973 1974 sx_xlock(&enc->enc_cache_lock); 1975 ses_cache_clone(enc, /*src*/&enc->enc_daemon_cache, 1976 /*dst*/&enc->enc_cache); 1977 sx_xunlock(&enc->enc_cache_lock); 1978 1979 return (0); 1980 } 1981 1982 /* 1983 * \brief Sanitize an element descriptor 1984 * 1985 * The SES4r3 standard, sections 3.1.2 and 6.1.10, specifies that element 1986 * descriptors may only contain ASCII characters in the range 0x20 to 0x7e. 1987 * But some vendors violate that rule. Ensure that we only expose compliant 1988 * descriptors to userland. 1989 * 1990 * \param desc SES element descriptor as reported by the hardware 1991 * \param len Length of desc in bytes, not necessarily including 1992 * trailing NUL. It will be modified if desc is invalid. 1993 */ 1994 static const char* 1995 ses_sanitize_elm_desc(const char *desc, uint16_t *len) 1996 { 1997 const char *invalid = "<invalid>"; 1998 int i; 1999 2000 for (i = 0; i < *len; i++) { 2001 if (desc[i] == 0) { 2002 break; 2003 } else if (desc[i] < 0x20 || desc[i] > 0x7e) { 2004 *len = strlen(invalid); 2005 return (invalid); 2006 } 2007 } 2008 return (desc); 2009 } 2010 2011 /** 2012 * \brief Parse the descriptors for each object. 2013 * 2014 * \param enc The SES softc to update. 2015 * \param buf The buffer containing the descriptor list response. 2016 * \param xfer_len Size of the buffer. 2017 * 2018 * \return 0 on success, errno otherwise. 2019 */ 2020 static int 2021 ses_process_elm_descs(enc_softc_t *enc, struct enc_fsm_state *state, 2022 union ccb *ccb, uint8_t **bufp, int error, int xfer_len) 2023 { 2024 ses_softc_t *ses; 2025 struct ses_iterator iter; 2026 enc_element_t *element; 2027 int err; 2028 int offset; 2029 u_long length, plength; 2030 enc_cache_t *enc_cache; 2031 ses_cache_t *ses_cache; 2032 uint8_t *buf; 2033 ses_element_t *elmpriv; 2034 const struct ses_page_hdr *phdr; 2035 const struct ses_elm_desc_hdr *hdr; 2036 2037 ses = enc->enc_private; 2038 enc_cache = &enc->enc_daemon_cache; 2039 ses_cache = enc_cache->private; 2040 buf = *bufp; 2041 err = -1; 2042 2043 if (error != 0) { 2044 err = error; 2045 goto out; 2046 } 2047 ses_cache_free_elm_descs(enc, enc_cache); 2048 ses_cache->elm_descs_page = (struct ses_elem_descr_page *)buf; 2049 *bufp = NULL; 2050 2051 phdr = &ses_cache->elm_descs_page->hdr; 2052 plength = ses_page_length(phdr); 2053 if (xfer_len < sizeof(struct ses_page_hdr)) { 2054 ENC_VLOG(enc, "Runt Element Descriptor Page\n"); 2055 goto out; 2056 } 2057 if (plength > xfer_len) { 2058 ENC_VLOG(enc, "Element Descriptor Page Too Long\n"); 2059 goto out; 2060 } 2061 2062 if (!ses_config_cache_valid(ses_cache, phdr->gen_code)) { 2063 ENC_VLOG(enc, "%s: Generation count change detected\n", 2064 __func__); 2065 enc_update_request(enc, SES_UPDATE_GETCONFIG); 2066 goto out; 2067 } 2068 2069 offset = sizeof(struct ses_page_hdr); 2070 2071 ses_iter_init(enc, enc_cache, &iter); 2072 while (offset < plength 2073 && (element = ses_iter_next(&iter)) != NULL) { 2074 if ((offset + sizeof(struct ses_elm_desc_hdr)) > plength) { 2075 ENC_VLOG(enc, "Element %d Descriptor Header Past " 2076 "End of Buffer\n", iter.global_element_index); 2077 goto out; 2078 } 2079 hdr = (struct ses_elm_desc_hdr *)&buf[offset]; 2080 length = scsi_2btoul(hdr->length); 2081 ENC_DLOG(enc, "%s: obj %d(%d,%d) length=%d off=%d\n", __func__, 2082 iter.global_element_index, iter.type_index, 2083 iter.type_element_index, length, offset); 2084 if ((offset + sizeof(*hdr) + length) > plength) { 2085 ENC_VLOG(enc, "Element%d Descriptor Past " 2086 "End of Buffer\n", iter.global_element_index); 2087 goto out; 2088 } 2089 offset += sizeof(*hdr); 2090 2091 if (length > 0) { 2092 elmpriv = element->elm_private; 2093 elmpriv->descr_len = length; 2094 elmpriv->descr = ses_sanitize_elm_desc(&buf[offset], 2095 &elmpriv->descr_len); 2096 } 2097 2098 /* skip over the descriptor itself */ 2099 offset += length; 2100 } 2101 2102 err = 0; 2103 out: 2104 if (err == 0) { 2105 if (ses->ses_flags & SES_FLAG_ADDLSTATUS) 2106 enc_update_request(enc, SES_UPDATE_GETELMADDLSTATUS); 2107 } 2108 enc_update_request(enc, SES_PUBLISH_CACHE); 2109 return (err); 2110 } 2111 2112 static int 2113 ses_fill_rcv_diag_io(enc_softc_t *enc, struct enc_fsm_state *state, 2114 union ccb *ccb, uint8_t *buf) 2115 { 2116 2117 if (enc->enc_type == ENC_SEMB_SES) { 2118 semb_receive_diagnostic_results(&ccb->ataio, /*retries*/5, 2119 NULL, MSG_SIMPLE_Q_TAG, /*pcv*/1, 2120 state->page_code, buf, state->buf_size, 2121 state->timeout); 2122 } else { 2123 scsi_receive_diagnostic_results(&ccb->csio, /*retries*/5, 2124 NULL, MSG_SIMPLE_Q_TAG, /*pcv*/1, 2125 state->page_code, buf, state->buf_size, 2126 SSD_FULL_SIZE, state->timeout); 2127 } 2128 return (0); 2129 } 2130 2131 /** 2132 * \brief Encode the object status into the response buffer, which is 2133 * expected to contain the current enclosure status. This function 2134 * turns off all the 'select' bits for the objects except for the 2135 * object specified, then sends it back to the enclosure. 2136 * 2137 * \param enc SES enclosure the change is being applied to. 2138 * \param buf Buffer containing the current enclosure status response. 2139 * \param amt Length of the response in the buffer. 2140 * \param req The control request to be applied to buf. 2141 * 2142 * \return 0 on success, errno otherwise. 2143 */ 2144 static int 2145 ses_encode(enc_softc_t *enc, uint8_t *buf, int amt, ses_control_request_t *req) 2146 { 2147 struct ses_iterator iter; 2148 enc_element_t *element; 2149 int offset; 2150 struct ses_control_page_hdr *hdr; 2151 2152 ses_iter_init(enc, &enc->enc_cache, &iter); 2153 hdr = (struct ses_control_page_hdr *)buf; 2154 if (req->elm_idx == -1) { 2155 /* for enclosure status, at least 2 bytes are needed */ 2156 if (amt < 2) 2157 return EIO; 2158 hdr->control_flags = 2159 req->elm_stat.comstatus & SES_SET_STATUS_MASK; 2160 ENC_DLOG(enc, "Set EncStat %x\n", hdr->control_flags); 2161 return (0); 2162 } 2163 2164 element = ses_iter_seek_to(&iter, req->elm_idx, SES_ELEM_INDEX_GLOBAL); 2165 if (element == NULL) 2166 return (ENXIO); 2167 2168 /* 2169 * Seek to the type set that corresponds to the requested object. 2170 * The +1 is for the overall status element for the type. 2171 */ 2172 offset = sizeof(struct ses_control_page_hdr) 2173 + (iter.global_element_index * sizeof(struct ses_comstat)); 2174 2175 /* Check for buffer overflow. */ 2176 if (offset + sizeof(struct ses_comstat) > amt) 2177 return (EIO); 2178 2179 /* Set the status. */ 2180 memcpy(&buf[offset], &req->elm_stat, sizeof(struct ses_comstat)); 2181 2182 ENC_DLOG(enc, "Set Type 0x%x Obj 0x%x (offset %d) with %x %x %x %x\n", 2183 iter.type_index, iter.global_element_index, offset, 2184 req->elm_stat.comstatus, req->elm_stat.comstat[0], 2185 req->elm_stat.comstat[1], req->elm_stat.comstat[2]); 2186 2187 return (0); 2188 } 2189 2190 static int 2191 ses_fill_control_request(enc_softc_t *enc, struct enc_fsm_state *state, 2192 union ccb *ccb, uint8_t *buf) 2193 { 2194 ses_softc_t *ses; 2195 enc_cache_t *enc_cache; 2196 ses_cache_t *ses_cache; 2197 struct ses_control_page_hdr *hdr; 2198 ses_control_request_t *req; 2199 size_t plength; 2200 size_t offset; 2201 2202 ses = enc->enc_private; 2203 enc_cache = &enc->enc_daemon_cache; 2204 ses_cache = enc_cache->private; 2205 hdr = (struct ses_control_page_hdr *)buf; 2206 2207 if (ses_cache->status_page == NULL) { 2208 ses_terminate_control_requests(&ses->ses_requests, EIO); 2209 return (EIO); 2210 } 2211 2212 plength = ses_page_length(&ses_cache->status_page->hdr); 2213 memcpy(buf, ses_cache->status_page, plength); 2214 2215 /* Disable the select bits in all status entries. */ 2216 offset = sizeof(struct ses_control_page_hdr); 2217 for (offset = sizeof(struct ses_control_page_hdr); 2218 offset < plength; offset += sizeof(struct ses_comstat)) { 2219 buf[offset] &= ~SESCTL_CSEL; 2220 } 2221 2222 /* And make sure the INVOP bit is clear. */ 2223 hdr->control_flags &= ~SES_ENCSTAT_INVOP; 2224 2225 /* Apply incoming requests. */ 2226 while ((req = TAILQ_FIRST(&ses->ses_requests)) != NULL) { 2227 TAILQ_REMOVE(&ses->ses_requests, req, links); 2228 req->result = ses_encode(enc, buf, plength, req); 2229 if (req->result != 0) { 2230 wakeup(req); 2231 continue; 2232 } 2233 TAILQ_INSERT_TAIL(&ses->ses_pending_requests, req, links); 2234 } 2235 2236 if (TAILQ_EMPTY(&ses->ses_pending_requests) != 0) 2237 return (ENOENT); 2238 2239 /* Fill out the ccb */ 2240 if (enc->enc_type == ENC_SEMB_SES) { 2241 semb_send_diagnostic(&ccb->ataio, /*retries*/5, NULL, 2242 MSG_SIMPLE_Q_TAG, 2243 buf, ses_page_length(&ses_cache->status_page->hdr), 2244 state->timeout); 2245 } else { 2246 scsi_send_diagnostic(&ccb->csio, /*retries*/5, NULL, 2247 MSG_SIMPLE_Q_TAG, /*unit_offline*/0, 2248 /*device_offline*/0, /*self_test*/0, 2249 /*page_format*/1, /*self_test_code*/0, 2250 buf, ses_page_length(&ses_cache->status_page->hdr), 2251 SSD_FULL_SIZE, state->timeout); 2252 } 2253 return (0); 2254 } 2255 2256 static int 2257 ses_get_elm_addlstatus_fc(enc_softc_t *enc, enc_cache_t *enc_cache, 2258 uint8_t *buf, int bufsiz) 2259 { 2260 ENC_VLOG(enc, "FC Device Support Stubbed in Additional Status Page\n"); 2261 return (ENODEV); 2262 } 2263 2264 #define SES_PRINT_PORTS(p, type) do { \ 2265 if (((p) & SES_SASOBJ_DEV_PHY_PROTOMASK) != 0) { \ 2266 sbuf_printf(sbp, " %s (", type); \ 2267 if ((p) & SES_SASOBJ_DEV_PHY_SMP) \ 2268 sbuf_cat(sbp, " SMP"); \ 2269 if ((p) & SES_SASOBJ_DEV_PHY_STP) \ 2270 sbuf_cat(sbp, " STP"); \ 2271 if ((p) & SES_SASOBJ_DEV_PHY_SSP) \ 2272 sbuf_cat(sbp, " SSP"); \ 2273 sbuf_cat(sbp, " )"); \ 2274 } \ 2275 } while(0) 2276 2277 /** 2278 * \brief Print the additional element status data for this object, for SAS 2279 * type 0 objects. See SES2 r20 Section 6.1.13.3.2. 2280 * 2281 * \param sesname SES device name associated with the object. 2282 * \param sbp Sbuf to print to. 2283 * \param obj The object to print the data for. 2284 */ 2285 static void 2286 ses_print_addl_data_sas_type0(char *sesname, struct sbuf *sbp, 2287 enc_element_t *obj) 2288 { 2289 int i; 2290 ses_element_t *elmpriv; 2291 struct ses_addl_status *addl; 2292 struct ses_elm_sas_device_phy *phy; 2293 2294 elmpriv = obj->elm_private; 2295 addl = &(elmpriv->addl); 2296 sbuf_printf(sbp, ", SAS Slot: %d%s phys", 2297 addl->proto_hdr.sas->base_hdr.num_phys, 2298 ses_elm_sas_type0_not_all_phys(addl->proto_hdr.sas) ? "+" : ""); 2299 if (ses_elm_addlstatus_eip(addl->hdr)) 2300 sbuf_printf(sbp, " at slot %d", 2301 addl->proto_hdr.sas->type0_eip.dev_slot_num); 2302 sbuf_putc(sbp, '\n'); 2303 if (addl->proto_data.sasdev_phys == NULL) 2304 return; 2305 for (i = 0;i < addl->proto_hdr.sas->base_hdr.num_phys;i++) { 2306 phy = &addl->proto_data.sasdev_phys[i]; 2307 sbuf_printf(sbp, "%s: phy %d:", sesname, i); 2308 if (ses_elm_sas_dev_phy_sata_dev(phy)) 2309 /* Spec says all other fields are specific values */ 2310 sbuf_cat(sbp, " SATA device\n"); 2311 else { 2312 sbuf_printf(sbp, " SAS device type %d phy %d", 2313 ses_elm_sas_dev_phy_dev_type(phy), phy->phy_id); 2314 SES_PRINT_PORTS(phy->initiator_ports, "Initiator"); 2315 SES_PRINT_PORTS(phy->target_ports, "Target"); 2316 sbuf_putc(sbp, '\n'); 2317 } 2318 sbuf_printf(sbp, "%s: phy %d: parent %jx addr %jx\n", 2319 sesname, i, 2320 (uintmax_t)scsi_8btou64(phy->parent_addr), 2321 (uintmax_t)scsi_8btou64(phy->phy_addr)); 2322 } 2323 } 2324 #undef SES_PRINT_PORTS 2325 2326 /** 2327 * \brief Print the additional element status data for this object, for SAS 2328 * type 1 objects. See SES2 r20 Sections 6.1.13.3.3 and 6.1.13.3.4. 2329 * 2330 * \param sesname SES device name associated with the object. 2331 * \param sbp Sbuf to print to. 2332 * \param obj The object to print the data for. 2333 */ 2334 static void 2335 ses_print_addl_data_sas_type1(char *sesname, struct sbuf *sbp, 2336 enc_element_t *obj) 2337 { 2338 int i, num_phys; 2339 ses_element_t *elmpriv; 2340 struct ses_addl_status *addl; 2341 struct ses_elm_sas_expander_phy *exp_phy; 2342 struct ses_elm_sas_port_phy *port_phy; 2343 2344 elmpriv = obj->elm_private; 2345 addl = &(elmpriv->addl); 2346 sbuf_cat(sbp, ", SAS "); 2347 if (obj->elm_type == ELMTYP_SAS_EXP) { 2348 num_phys = addl->proto_hdr.sas->base_hdr.num_phys; 2349 sbuf_printf(sbp, "Expander: %d phys", num_phys); 2350 if (addl->proto_data.sasexp_phys == NULL) 2351 return; 2352 for (i = 0;i < num_phys;i++) { 2353 exp_phy = &addl->proto_data.sasexp_phys[i]; 2354 sbuf_printf(sbp, "%s: phy %d: connector %d other %d\n", 2355 sesname, i, exp_phy->connector_index, 2356 exp_phy->other_index); 2357 } 2358 } else { 2359 num_phys = addl->proto_hdr.sas->base_hdr.num_phys; 2360 sbuf_printf(sbp, "Port: %d phys", num_phys); 2361 if (addl->proto_data.sasport_phys == NULL) 2362 return; 2363 for (i = 0;i < num_phys;i++) { 2364 port_phy = &addl->proto_data.sasport_phys[i]; 2365 sbuf_printf(sbp, 2366 "%s: phy %d: id %d connector %d other %d\n", 2367 sesname, i, port_phy->phy_id, 2368 port_phy->connector_index, port_phy->other_index); 2369 sbuf_printf(sbp, "%s: phy %d: addr %jx\n", sesname, i, 2370 (uintmax_t)scsi_8btou64(port_phy->phy_addr)); 2371 } 2372 } 2373 } 2374 2375 /** 2376 * \brief Print the additional element status data for this object, for 2377 * ATA objects. 2378 * 2379 * \param sbp Sbuf to print to. 2380 * \param obj The object to print the data for. 2381 */ 2382 static void 2383 ses_print_addl_data_ata(struct sbuf *sbp, enc_element_t *obj) 2384 { 2385 ses_element_t *elmpriv = obj->elm_private; 2386 struct ses_addl_status *addl = &elmpriv->addl; 2387 struct ses_elm_ata_hdr *ata = addl->proto_hdr.ata; 2388 2389 sbuf_printf(sbp, ", SATA Slot: scbus%d target %d\n", 2390 scsi_4btoul(ata->bus), scsi_4btoul(ata->target)); 2391 } 2392 2393 /** 2394 * \brief Print the additional element status data for this object. 2395 * 2396 * \param enc SES softc associated with the object. 2397 * \param obj The object to print the data for. 2398 */ 2399 static void 2400 ses_print_addl_data(enc_softc_t *enc, enc_element_t *obj) 2401 { 2402 ses_element_t *elmpriv; 2403 struct ses_addl_status *addl; 2404 struct sbuf sesname, name, out; 2405 2406 elmpriv = obj->elm_private; 2407 if (elmpriv == NULL) 2408 return; 2409 2410 addl = &(elmpriv->addl); 2411 if (addl->hdr == NULL) 2412 return; 2413 2414 sbuf_new(&sesname, NULL, 16, SBUF_AUTOEXTEND); 2415 sbuf_new(&name, NULL, 16, SBUF_AUTOEXTEND); 2416 sbuf_new(&out, NULL, 512, SBUF_AUTOEXTEND); 2417 ses_paths_iter(enc, obj, ses_elmdevname_callback, &name); 2418 if (sbuf_len(&name) == 0) 2419 sbuf_cat(&name, "(none)"); 2420 sbuf_finish(&name); 2421 sbuf_printf(&sesname, "%s%d", enc->periph->periph_name, 2422 enc->periph->unit_number); 2423 sbuf_finish(&sesname); 2424 sbuf_printf(&out, "%s: %s in ", sbuf_data(&sesname), sbuf_data(&name)); 2425 if (elmpriv->descr != NULL) 2426 sbuf_printf(&out, "'%s'", elmpriv->descr); 2427 else { 2428 if (obj->elm_type <= ELMTYP_LAST) 2429 sbuf_cat(&out, elm_type_names[obj->elm_type]); 2430 else 2431 sbuf_printf(&out, "<Type 0x%02x>", obj->elm_type); 2432 sbuf_printf(&out, " %d", obj->type_elm_idx); 2433 if (obj->subenclosure != 0) 2434 sbuf_printf(&out, " of subenc %d", obj->subenclosure); 2435 } 2436 switch(ses_elm_addlstatus_proto(addl->hdr)) { 2437 case SPSP_PROTO_FC: 2438 goto noaddl; /* stubbed for now */ 2439 case SPSP_PROTO_SAS: 2440 if (addl->proto_hdr.sas == NULL) 2441 goto noaddl; 2442 switch(ses_elm_sas_descr_type(addl->proto_hdr.sas)) { 2443 case SES_SASOBJ_TYPE_SLOT: 2444 ses_print_addl_data_sas_type0(sbuf_data(&sesname), 2445 &out, obj); 2446 break; 2447 case SES_SASOBJ_TYPE_OTHER: 2448 ses_print_addl_data_sas_type1(sbuf_data(&sesname), 2449 &out, obj); 2450 break; 2451 default: 2452 goto noaddl; 2453 } 2454 break; 2455 case SPSP_PROTO_ATA: 2456 if (addl->proto_hdr.ata == NULL) 2457 goto noaddl; 2458 ses_print_addl_data_ata(&out, obj); 2459 break; 2460 default: 2461 noaddl: 2462 sbuf_cat(&out, "\n"); 2463 break; 2464 } 2465 sbuf_finish(&out); 2466 printf("%s", sbuf_data(&out)); 2467 sbuf_delete(&out); 2468 sbuf_delete(&name); 2469 sbuf_delete(&sesname); 2470 } 2471 2472 /** 2473 * \brief Update the softc with the additional element status data for this 2474 * object, for SAS type 0 objects. 2475 * 2476 * \param enc SES softc to be updated. 2477 * \param buf The additional element status response buffer. 2478 * \param bufsiz Size of the response buffer. 2479 * \param eip The EIP bit value. 2480 * \param nobj Number of objects attached to the SES softc. 2481 * 2482 * \return 0 on success, errno otherwise. 2483 */ 2484 static int 2485 ses_get_elm_addlstatus_sas_type0(enc_softc_t *enc, enc_cache_t *enc_cache, 2486 uint8_t *buf, int bufsiz, int eip, int nobj) 2487 { 2488 int err, offset, physz; 2489 enc_element_t *obj; 2490 ses_element_t *elmpriv; 2491 struct ses_addl_status *addl; 2492 2493 err = offset = 0; 2494 2495 /* basic object setup */ 2496 obj = &(enc_cache->elm_map[nobj]); 2497 elmpriv = obj->elm_private; 2498 addl = &(elmpriv->addl); 2499 2500 addl->proto_hdr.sas = (union ses_elm_sas_hdr *)&buf[offset]; 2501 2502 /* Don't assume this object has any phys */ 2503 bzero(&addl->proto_data, sizeof(addl->proto_data)); 2504 if (addl->proto_hdr.sas->base_hdr.num_phys == 0) 2505 goto out; 2506 2507 /* Skip forward to the phy list */ 2508 if (eip) 2509 offset += sizeof(struct ses_elm_sas_type0_eip_hdr); 2510 else 2511 offset += sizeof(struct ses_elm_sas_type0_base_hdr); 2512 2513 /* Make sure the phy list fits in the buffer */ 2514 physz = addl->proto_hdr.sas->base_hdr.num_phys; 2515 physz *= sizeof(struct ses_elm_sas_device_phy); 2516 if (physz > (bufsiz - offset + 4)) { 2517 ENC_VLOG(enc, "Element %d Device Phy List Beyond End Of Buffer\n", 2518 nobj); 2519 err = EIO; 2520 goto out; 2521 } 2522 2523 /* Point to the phy list */ 2524 addl->proto_data.sasdev_phys = 2525 (struct ses_elm_sas_device_phy *)&buf[offset]; 2526 2527 out: 2528 return (err); 2529 } 2530 2531 /** 2532 * \brief Update the softc with the additional element status data for this 2533 * object, for SAS type 1 objects. 2534 * 2535 * \param enc SES softc to be updated. 2536 * \param buf The additional element status response buffer. 2537 * \param bufsiz Size of the response buffer. 2538 * \param eip The EIP bit value. 2539 * \param nobj Number of objects attached to the SES softc. 2540 * 2541 * \return 0 on success, errno otherwise. 2542 */ 2543 static int 2544 ses_get_elm_addlstatus_sas_type1(enc_softc_t *enc, enc_cache_t *enc_cache, 2545 uint8_t *buf, int bufsiz, int eip, int nobj) 2546 { 2547 int err, offset, physz; 2548 enc_element_t *obj; 2549 ses_element_t *elmpriv; 2550 struct ses_addl_status *addl; 2551 2552 err = offset = 0; 2553 2554 /* basic object setup */ 2555 obj = &(enc_cache->elm_map[nobj]); 2556 elmpriv = obj->elm_private; 2557 addl = &(elmpriv->addl); 2558 2559 addl->proto_hdr.sas = (union ses_elm_sas_hdr *)&buf[offset]; 2560 2561 /* Don't assume this object has any phys */ 2562 bzero(&addl->proto_data, sizeof(addl->proto_data)); 2563 if (addl->proto_hdr.sas->base_hdr.num_phys == 0) 2564 goto out; 2565 2566 /* Process expanders differently from other type1 cases */ 2567 if (obj->elm_type == ELMTYP_SAS_EXP) { 2568 offset += sizeof(struct ses_elm_sas_type1_expander_hdr); 2569 physz = addl->proto_hdr.sas->base_hdr.num_phys * 2570 sizeof(struct ses_elm_sas_expander_phy); 2571 if (physz > (bufsiz - offset)) { 2572 ENC_VLOG(enc, "Element %d: Expander Phy List Beyond " 2573 "End Of Buffer\n", nobj); 2574 err = EIO; 2575 goto out; 2576 } 2577 addl->proto_data.sasexp_phys = 2578 (struct ses_elm_sas_expander_phy *)&buf[offset]; 2579 } else { 2580 offset += sizeof(struct ses_elm_sas_type1_nonexpander_hdr); 2581 physz = addl->proto_hdr.sas->base_hdr.num_phys * 2582 sizeof(struct ses_elm_sas_port_phy); 2583 if (physz > (bufsiz - offset + 4)) { 2584 ENC_VLOG(enc, "Element %d: Port Phy List Beyond End " 2585 "Of Buffer\n", nobj); 2586 err = EIO; 2587 goto out; 2588 } 2589 addl->proto_data.sasport_phys = 2590 (struct ses_elm_sas_port_phy *)&buf[offset]; 2591 } 2592 2593 out: 2594 return (err); 2595 } 2596 2597 /** 2598 * \brief Update the softc with the additional element status data for this 2599 * object, for SAS objects. 2600 * 2601 * \param enc SES softc to be updated. 2602 * \param buf The additional element status response buffer. 2603 * \param bufsiz Size of the response buffer. 2604 * \param eip The EIP bit value. 2605 * \param tidx Type index for this object. 2606 * \param nobj Number of objects attached to the SES softc. 2607 * 2608 * \return 0 on success, errno otherwise. 2609 */ 2610 static int 2611 ses_get_elm_addlstatus_sas(enc_softc_t *enc, enc_cache_t *enc_cache, 2612 uint8_t *buf, int bufsiz, int eip, int tidx, 2613 int nobj) 2614 { 2615 int dtype, err; 2616 ses_cache_t *ses_cache; 2617 union ses_elm_sas_hdr *hdr; 2618 2619 /* Need to be able to read the descriptor type! */ 2620 if (bufsiz < sizeof(union ses_elm_sas_hdr)) { 2621 err = EIO; 2622 goto out; 2623 } 2624 2625 ses_cache = enc_cache->private; 2626 2627 hdr = (union ses_elm_sas_hdr *)buf; 2628 dtype = ses_elm_sas_descr_type(hdr); 2629 switch(dtype) { 2630 case SES_SASOBJ_TYPE_SLOT: 2631 switch(ses_cache->ses_types[tidx].hdr->etype_elm_type) { 2632 case ELMTYP_DEVICE: 2633 case ELMTYP_ARRAY_DEV: 2634 break; 2635 default: 2636 ENC_VLOG(enc, "Element %d has Additional Status type 0, " 2637 "invalid for SES element type 0x%x\n", nobj, 2638 ses_cache->ses_types[tidx].hdr->etype_elm_type); 2639 err = ENODEV; 2640 goto out; 2641 } 2642 err = ses_get_elm_addlstatus_sas_type0(enc, enc_cache, 2643 buf, bufsiz, eip, 2644 nobj); 2645 break; 2646 case SES_SASOBJ_TYPE_OTHER: 2647 switch(ses_cache->ses_types[tidx].hdr->etype_elm_type) { 2648 case ELMTYP_SAS_EXP: 2649 case ELMTYP_SCSI_INI: 2650 case ELMTYP_SCSI_TGT: 2651 case ELMTYP_ESCC: 2652 break; 2653 default: 2654 ENC_VLOG(enc, "Element %d has Additional Status type 1, " 2655 "invalid for SES element type 0x%x\n", nobj, 2656 ses_cache->ses_types[tidx].hdr->etype_elm_type); 2657 err = ENODEV; 2658 goto out; 2659 } 2660 err = ses_get_elm_addlstatus_sas_type1(enc, enc_cache, buf, 2661 bufsiz, eip, nobj); 2662 break; 2663 default: 2664 ENC_VLOG(enc, "Element %d of type 0x%x has Additional Status " 2665 "of unknown type 0x%x\n", nobj, 2666 ses_cache->ses_types[tidx].hdr->etype_elm_type, dtype); 2667 err = ENODEV; 2668 break; 2669 } 2670 2671 out: 2672 return (err); 2673 } 2674 2675 /** 2676 * \brief Update the softc with the additional element status data for this 2677 * object, for ATA objects. 2678 * 2679 * \param enc SES softc to be updated. 2680 * \param buf The additional element status response buffer. 2681 * \param bufsiz Size of the response buffer. 2682 * \param eip The EIP bit value. 2683 * \param tidx Type index for this object. 2684 * \param nobj Number of objects attached to the SES softc. 2685 * 2686 * \return 0 on success, errno otherwise. 2687 */ 2688 static int 2689 ses_get_elm_addlstatus_ata(enc_softc_t *enc, enc_cache_t *enc_cache, 2690 uint8_t *buf, int bufsiz, int eip, int tidx, 2691 int nobj) 2692 { 2693 int err; 2694 ses_cache_t *ses_cache; 2695 2696 if (bufsiz < sizeof(struct ses_elm_ata_hdr)) { 2697 err = EIO; 2698 goto out; 2699 } 2700 2701 ses_cache = enc_cache->private; 2702 switch(ses_cache->ses_types[tidx].hdr->etype_elm_type) { 2703 case ELMTYP_DEVICE: 2704 case ELMTYP_ARRAY_DEV: 2705 break; 2706 default: 2707 ENC_VLOG(enc, "Element %d has Additional Status, " 2708 "invalid for SES element type 0x%x\n", nobj, 2709 ses_cache->ses_types[tidx].hdr->etype_elm_type); 2710 err = ENODEV; 2711 goto out; 2712 } 2713 2714 ((ses_element_t *)enc_cache->elm_map[nobj].elm_private) 2715 ->addl.proto_hdr.ata = (struct ses_elm_ata_hdr *)buf; 2716 err = 0; 2717 2718 out: 2719 return (err); 2720 } 2721 2722 static void 2723 ses_softc_invalidate(enc_softc_t *enc) 2724 { 2725 ses_softc_t *ses; 2726 2727 ses = enc->enc_private; 2728 ses_terminate_control_requests(&ses->ses_requests, ENXIO); 2729 } 2730 2731 static void 2732 ses_softc_cleanup(enc_softc_t *enc) 2733 { 2734 2735 ses_cache_free(enc, &enc->enc_cache); 2736 ses_cache_free(enc, &enc->enc_daemon_cache); 2737 ENC_FREE_AND_NULL(enc->enc_private); 2738 ENC_FREE_AND_NULL(enc->enc_cache.private); 2739 ENC_FREE_AND_NULL(enc->enc_daemon_cache.private); 2740 } 2741 2742 static int 2743 ses_init_enc(enc_softc_t *enc) 2744 { 2745 return (0); 2746 } 2747 2748 static int 2749 ses_set_enc_status(enc_softc_t *enc, uint8_t encstat, int slpflag) 2750 { 2751 ses_control_request_t req; 2752 ses_softc_t *ses; 2753 2754 ses = enc->enc_private; 2755 req.elm_idx = SES_SETSTATUS_ENC_IDX; 2756 req.elm_stat.comstatus = encstat & 0xf; 2757 2758 TAILQ_INSERT_TAIL(&ses->ses_requests, &req, links); 2759 enc_update_request(enc, SES_PROCESS_CONTROL_REQS); 2760 cam_periph_sleep(enc->periph, &req, PUSER, "encstat", 0); 2761 2762 return (req.result); 2763 } 2764 2765 static int 2766 ses_get_elm_status(enc_softc_t *enc, encioc_elm_status_t *elms, int slpflag) 2767 { 2768 unsigned int i = elms->elm_idx; 2769 2770 memcpy(elms->cstat, &enc->enc_cache.elm_map[i].encstat, 4); 2771 return (0); 2772 } 2773 2774 static int 2775 ses_set_elm_status(enc_softc_t *enc, encioc_elm_status_t *elms, int slpflag) 2776 { 2777 ses_control_request_t req; 2778 ses_softc_t *ses; 2779 2780 /* If this is clear, we don't do diddly. */ 2781 if ((elms->cstat[0] & SESCTL_CSEL) == 0) 2782 return (0); 2783 2784 ses = enc->enc_private; 2785 req.elm_idx = elms->elm_idx; 2786 memcpy(&req.elm_stat, elms->cstat, sizeof(req.elm_stat)); 2787 2788 TAILQ_INSERT_TAIL(&ses->ses_requests, &req, links); 2789 enc_update_request(enc, SES_PROCESS_CONTROL_REQS); 2790 cam_periph_sleep(enc->periph, &req, PUSER, "encstat", 0); 2791 2792 return (req.result); 2793 } 2794 2795 static int 2796 ses_get_elm_desc(enc_softc_t *enc, encioc_elm_desc_t *elmd) 2797 { 2798 int i = (int)elmd->elm_idx; 2799 ses_element_t *elmpriv; 2800 2801 /* Assume caller has already checked obj_id validity */ 2802 elmpriv = enc->enc_cache.elm_map[i].elm_private; 2803 /* object might not have a descriptor */ 2804 if (elmpriv == NULL || elmpriv->descr == NULL) { 2805 elmd->elm_desc_len = 0; 2806 return (0); 2807 } 2808 if (elmd->elm_desc_len > elmpriv->descr_len) 2809 elmd->elm_desc_len = elmpriv->descr_len; 2810 return (copyout(elmpriv->descr, elmd->elm_desc_str, 2811 elmd->elm_desc_len)); 2812 } 2813 2814 /** 2815 * \brief Respond to ENCIOC_GETELMDEVNAME, providing a device name for the 2816 * given object id if one is available. 2817 * 2818 * \param enc SES softc to examine. 2819 * \param objdn ioctl structure to read/write device name info. 2820 * 2821 * \return 0 on success, errno otherwise. 2822 */ 2823 static int 2824 ses_get_elm_devnames(enc_softc_t *enc, encioc_elm_devnames_t *elmdn) 2825 { 2826 struct sbuf sb; 2827 int error, len; 2828 2829 len = elmdn->elm_names_size; 2830 if (len < 0) 2831 return (EINVAL); 2832 2833 cam_periph_unlock(enc->periph); 2834 sbuf_new(&sb, NULL, len, SBUF_FIXEDLEN); 2835 ses_paths_iter(enc, &enc->enc_cache.elm_map[elmdn->elm_idx], 2836 ses_elmdevname_callback, &sb); 2837 sbuf_finish(&sb); 2838 elmdn->elm_names_len = sbuf_len(&sb); 2839 error = copyout(sbuf_data(&sb), elmdn->elm_devnames, 2840 elmdn->elm_names_len + 1); 2841 sbuf_delete(&sb); 2842 cam_periph_lock(enc->periph); 2843 if (error == 0 && elmdn->elm_names_len == 0) 2844 error = ENODEV; 2845 return (error); 2846 } 2847 2848 /** 2849 * \brief Send a string to the primary subenclosure using the String Out 2850 * SES diagnostic page. 2851 * 2852 * \param enc SES enclosure to run the command on. 2853 * \param sstr SES string structure to operate on 2854 * \param ioc Ioctl being performed 2855 * 2856 * \return 0 on success, errno otherwise. 2857 */ 2858 static int 2859 ses_handle_string(enc_softc_t *enc, encioc_string_t *sstr, unsigned long ioc) 2860 { 2861 enc_cache_t *enc_cache; 2862 ses_cache_t *ses_cache; 2863 const struct ses_enc_desc *enc_desc; 2864 int amt, payload, ret; 2865 char cdb[6]; 2866 char str[32]; 2867 char vendor[9]; 2868 char product[17]; 2869 char rev[5]; 2870 uint8_t *buf; 2871 size_t size, rsize; 2872 2873 enc_cache = &enc->enc_daemon_cache; 2874 ses_cache = enc_cache->private; 2875 2876 /* Implement SES2r20 6.1.6 */ 2877 if (sstr->bufsiz > ENC_STRING_MAX) 2878 return (EINVAL); /* buffer size too large */ 2879 2880 switch (ioc) { 2881 case ENCIOC_SETSTRING: 2882 payload = sstr->bufsiz + 4; /* header for SEND DIAGNOSTIC */ 2883 amt = 0 - payload; 2884 buf = ENC_MALLOC(payload); 2885 if (buf == NULL) 2886 return (ENOMEM); 2887 ses_page_cdb(cdb, payload, 0, CAM_DIR_OUT); 2888 /* Construct the page request */ 2889 buf[0] = SesStringOut; 2890 buf[1] = 0; 2891 buf[2] = sstr->bufsiz >> 8; 2892 buf[3] = sstr->bufsiz & 0xff; 2893 ret = copyin(sstr->buf, &buf[4], sstr->bufsiz); 2894 if (ret != 0) { 2895 ENC_FREE(buf); 2896 return (ret); 2897 } 2898 break; 2899 case ENCIOC_GETSTRING: 2900 payload = sstr->bufsiz; 2901 amt = payload; 2902 buf = ENC_MALLOC(payload); 2903 if (buf == NULL) 2904 return (ENOMEM); 2905 ses_page_cdb(cdb, payload, SesStringIn, CAM_DIR_IN); 2906 break; 2907 case ENCIOC_GETENCNAME: 2908 if (ses_cache->ses_nsubencs < 1) 2909 return (ENODEV); 2910 enc_desc = ses_cache->subencs[0]; 2911 cam_strvis(vendor, enc_desc->vendor_id, 2912 sizeof(enc_desc->vendor_id), sizeof(vendor)); 2913 cam_strvis(product, enc_desc->product_id, 2914 sizeof(enc_desc->product_id), sizeof(product)); 2915 cam_strvis(rev, enc_desc->product_rev, 2916 sizeof(enc_desc->product_rev), sizeof(rev)); 2917 rsize = snprintf(str, sizeof(str), "%s %s %s", 2918 vendor, product, rev) + 1; 2919 if (rsize > sizeof(str)) 2920 rsize = sizeof(str); 2921 size = rsize; 2922 if (size > sstr->bufsiz) 2923 size = sstr->bufsiz; 2924 ret = copyout(str, sstr->buf, size); 2925 sstr->bufsiz = rsize; 2926 return (ret != 0 ? ret : (size == rsize ? 0 : ENOMEM)); 2927 case ENCIOC_GETENCID: 2928 if (ses_cache->ses_nsubencs < 1) 2929 return (ENODEV); 2930 enc_desc = ses_cache->subencs[0]; 2931 rsize = snprintf(str, sizeof(str), "%16jx", 2932 scsi_8btou64(enc_desc->logical_id)) + 1; 2933 if (rsize > sizeof(str)) 2934 rsize = sizeof(str); 2935 size = rsize; 2936 if (size > sstr->bufsiz) 2937 size = sstr->bufsiz; 2938 ret = copyout(str, sstr->buf, size); 2939 sstr->bufsiz = rsize; 2940 return (ret != 0 ? ret : (size == rsize ? 0 : ENOMEM)); 2941 default: 2942 return (EINVAL); 2943 } 2944 ret = enc_runcmd(enc, cdb, 6, buf, &amt); 2945 if (ret == 0 && ioc == ENCIOC_GETSTRING) 2946 ret = copyout(buf, sstr->buf, sstr->bufsiz); 2947 if (ioc == ENCIOC_SETSTRING || ioc == ENCIOC_GETSTRING) 2948 ENC_FREE(buf); 2949 return (ret); 2950 } 2951 2952 /** 2953 * \invariant Called with cam_periph mutex held. 2954 */ 2955 static void 2956 ses_poll_status(enc_softc_t *enc) 2957 { 2958 ses_softc_t *ses; 2959 2960 ses = enc->enc_private; 2961 enc_update_request(enc, SES_UPDATE_GETSTATUS); 2962 if (ses->ses_flags & SES_FLAG_DESC) 2963 enc_update_request(enc, SES_UPDATE_GETELMDESCS); 2964 if (ses->ses_flags & SES_FLAG_ADDLSTATUS) 2965 enc_update_request(enc, SES_UPDATE_GETELMADDLSTATUS); 2966 } 2967 2968 /** 2969 * \brief Notification received when CAM detects a new device in the 2970 * SCSI domain in which this SEP resides. 2971 * 2972 * \param enc SES enclosure instance. 2973 */ 2974 static void 2975 ses_device_found(enc_softc_t *enc) 2976 { 2977 ses_poll_status(enc); 2978 enc_update_request(enc, SES_PUBLISH_PHYSPATHS); 2979 } 2980 2981 static struct enc_vec ses_enc_vec = 2982 { 2983 .softc_invalidate = ses_softc_invalidate, 2984 .softc_cleanup = ses_softc_cleanup, 2985 .init_enc = ses_init_enc, 2986 .set_enc_status = ses_set_enc_status, 2987 .get_elm_status = ses_get_elm_status, 2988 .set_elm_status = ses_set_elm_status, 2989 .get_elm_desc = ses_get_elm_desc, 2990 .get_elm_devnames = ses_get_elm_devnames, 2991 .handle_string = ses_handle_string, 2992 .device_found = ses_device_found, 2993 .poll_status = ses_poll_status 2994 }; 2995 2996 /** 2997 * \brief Initialize a new SES instance. 2998 * 2999 * \param enc SES softc structure to set up the instance in. 3000 * \param doinit Do the initialization (see main driver). 3001 * 3002 * \return 0 on success, errno otherwise. 3003 */ 3004 int 3005 ses_softc_init(enc_softc_t *enc) 3006 { 3007 ses_softc_t *ses_softc; 3008 3009 CAM_DEBUG(enc->periph->path, CAM_DEBUG_SUBTRACE, 3010 ("entering enc_softc_init(%p)\n", enc)); 3011 3012 enc->enc_vec = ses_enc_vec; 3013 enc->enc_fsm_states = enc_fsm_states; 3014 3015 if (enc->enc_private == NULL) 3016 enc->enc_private = ENC_MALLOCZ(sizeof(ses_softc_t)); 3017 if (enc->enc_cache.private == NULL) 3018 enc->enc_cache.private = ENC_MALLOCZ(sizeof(ses_cache_t)); 3019 if (enc->enc_daemon_cache.private == NULL) 3020 enc->enc_daemon_cache.private = 3021 ENC_MALLOCZ(sizeof(ses_cache_t)); 3022 3023 if (enc->enc_private == NULL 3024 || enc->enc_cache.private == NULL 3025 || enc->enc_daemon_cache.private == NULL) { 3026 ENC_FREE_AND_NULL(enc->enc_private); 3027 ENC_FREE_AND_NULL(enc->enc_cache.private); 3028 ENC_FREE_AND_NULL(enc->enc_daemon_cache.private); 3029 return (ENOMEM); 3030 } 3031 3032 ses_softc = enc->enc_private; 3033 TAILQ_INIT(&ses_softc->ses_requests); 3034 TAILQ_INIT(&ses_softc->ses_pending_requests); 3035 3036 enc_update_request(enc, SES_UPDATE_PAGES); 3037 3038 // XXX: Move this to the FSM so it doesn't hang init 3039 if (0) (void) ses_set_timed_completion(enc, 1); 3040 3041 return (0); 3042 } 3043