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