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