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