sys/dev/mps/mps_sas_lsi.c

   1 /*-
   2  * Copyright (c) 2011-2015 LSI Corp.
   3  * Copyright (c) 2013-2015 Avago Technologies
   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  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  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
  19  * FOR 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  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 /* Communications core for Avago Technologies (LSI) MPT2 */
  34
  35 /* TODO Move headers to mpsvar */
  36 #include <sys/types.h>
  37 #include <sys/param.h>
  38 #include <sys/systm.h>
  39 #include <sys/kernel.h>
  40 #include <sys/selinfo.h>
  41 #include <sys/module.h>
  42 #include <sys/bus.h>
  43 #include <sys/conf.h>
  44 #include <sys/bio.h>
  45 #include <sys/malloc.h>
  46 #include <sys/uio.h>
  47 #include <sys/sysctl.h>
  48 #include <sys/endian.h>
  49 #include <sys/queue.h>
  50 #include <sys/kthread.h>
  51 #include <sys/taskqueue.h>
  52 #include <sys/sbuf.h>
  53
  54 #include <machine/bus.h>
  55 #include <machine/resource.h>
  56 #include <sys/rman.h>
  57
  58 #include <machine/stdarg.h>
  59
  60 #include <cam/cam.h>
  61 #include <cam/cam_ccb.h>
  62 #include <cam/cam_debug.h>
  63 #include <cam/cam_sim.h>
  64 #include <cam/cam_xpt_sim.h>
  65 #include <cam/cam_xpt_periph.h>
  66 #include <cam/cam_periph.h>
  67 #include <cam/scsi/scsi_all.h>
  68 #include <cam/scsi/scsi_message.h>
  69
  70 #include <dev/mps/mpi/mpi2_type.h>
  71 #include <dev/mps/mpi/mpi2.h>
  72 #include <dev/mps/mpi/mpi2_ioc.h>
  73 #include <dev/mps/mpi/mpi2_sas.h>
  74 #include <dev/mps/mpi/mpi2_cnfg.h>
  75 #include <dev/mps/mpi/mpi2_init.h>
  76 #include <dev/mps/mpi/mpi2_raid.h>
  77 #include <dev/mps/mpi/mpi2_tool.h>
  78 #include <dev/mps/mps_ioctl.h>
  79 #include <dev/mps/mpsvar.h>
  80 #include <dev/mps/mps_table.h>
  81 #include <dev/mps/mps_sas.h>
  82
  83 /* For Hashed SAS Address creation for SATA Drives */
  84 #define MPT2SAS_SN_LEN 20
  85 #define MPT2SAS_MN_LEN 40
  86
  87 struct mps_fw_event_work {
  88         u16                     event;
  89         void                    *event_data;
  90         TAILQ_ENTRY(mps_fw_event_work)  ev_link;
  91 };
  92
  93 union _sata_sas_address {
  94         u8 wwid[8];
  95         struct {
  96                 u32 high;
  97                 u32 low;
  98         } word;
  99 };
 100
 101 /*
 102  * define the IDENTIFY DEVICE structure
 103  */
 104 struct _ata_identify_device_data {
 105         u16 reserved1[10];      /* 0-9 */
 106         u16 serial_number[10];  /* 10-19 */
 107         u16 reserved2[7];       /* 20-26 */
 108         u16 model_number[20];   /* 27-46*/
 109         u16 reserved3[170];     /* 47-216 */
 110         u16 rotational_speed;   /* 217 */
 111         u16 reserved4[38];      /* 218-255 */
 112 };
 113 static u32 event_count;
 114 static void mpssas_fw_work(struct mps_softc *sc,
 115     struct mps_fw_event_work *fw_event);
 116 static void mpssas_fw_event_free(struct mps_softc *,
 117     struct mps_fw_event_work *);
 118 static int mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate);
 119 static int mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
 120     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz,
 121     u32 devinfo);
 122 static void mpssas_ata_id_timeout(void *data);
 123 int mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
 124     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD);
 125 static int mpssas_volume_add(struct mps_softc *sc,
 126     u16 handle);
 127 static void mpssas_SSU_to_SATA_devices(struct mps_softc *sc);
 128 static void mpssas_stop_unit_done(struct cam_periph *periph,
 129     union ccb *done_ccb);
 130
 131 void
 132 mpssas_evt_handler(struct mps_softc *sc, uintptr_t data,
 133     MPI2_EVENT_NOTIFICATION_REPLY *event)
 134 {
 135         struct mps_fw_event_work *fw_event;
 136         u16 sz;
 137
 138         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
 139         mps_print_evt_sas(sc, event);
 140         mpssas_record_event(sc, event);
 141
 142         fw_event = malloc(sizeof(struct mps_fw_event_work), M_MPT2,
 143              M_ZERO|M_NOWAIT);
 144         if (!fw_event) {
 145                 printf("%s: allocate failed for fw_event\n", __func__);
 146                 return;
 147         }
 148         sz = le16toh(event->EventDataLength) * 4;
 149         fw_event->event_data = malloc(sz, M_MPT2, M_ZERO|M_NOWAIT);
 150         if (!fw_event->event_data) {
 151                 printf("%s: allocate failed for event_data\n", __func__);
 152                 free(fw_event, M_MPT2);
 153                 return;
 154         }
 155
 156         bcopy(event->EventData, fw_event->event_data, sz);
 157         fw_event->event = event->Event;
 158         if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
 159             event->Event == MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE ||
 160             event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
 161             sc->track_mapping_events)
 162                 sc->pending_map_events++;
 163
 164         /*
 165          * When wait_for_port_enable flag is set, make sure that all the events
 166          * are processed. Increment the startup_refcount and decrement it after
 167          * events are processed.
 168          */
 169         if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
 170             event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
 171             sc->wait_for_port_enable)
 172                 mpssas_startup_increment(sc->sassc);
 173
 174         TAILQ_INSERT_TAIL(&sc->sassc->ev_queue, fw_event, ev_link);
 175         taskqueue_enqueue(sc->sassc->ev_tq, &sc->sassc->ev_task);
 176
 177 }
 178
 179 static void
 180 mpssas_fw_event_free(struct mps_softc *sc, struct mps_fw_event_work *fw_event)
 181 {
 182
 183         free(fw_event->event_data, M_MPT2);
 184         free(fw_event, M_MPT2);
 185 }
 186
 187 /**
 188  * _mps_fw_work - delayed task for processing firmware events
 189  * @sc: per adapter object
 190  * @fw_event: The fw_event_work object
 191  * Context: user.
 192  *
 193  * Return nothing.
 194  */
 195 static void
 196 mpssas_fw_work(struct mps_softc *sc, struct mps_fw_event_work *fw_event)
 197 {
 198         struct mpssas_softc *sassc;
 199         sassc = sc->sassc;
 200
 201         mps_dprint(sc, MPS_EVENT, "(%d)->(%s) Working on  Event: [%x]\n",
 202                         event_count++,__func__,fw_event->event);
 203         switch (fw_event->event) {
 204         case MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST:
 205         {
 206                 MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *data;
 207                 MPI2_EVENT_SAS_TOPO_PHY_ENTRY *phy;
 208                 int i;
 209
 210                 data = (MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *)
 211                     fw_event->event_data;
 212
 213                 mps_mapping_topology_change_event(sc, fw_event->event_data);
 214
 215                 for (i = 0; i < data->NumEntries; i++) {
 216                         phy = &data->PHY[i];
 217                         switch (phy->PhyStatus & MPI2_EVENT_SAS_TOPO_RC_MASK) {
 218                         case MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED:
 219                                 if (mpssas_add_device(sc,
 220                                     le16toh(phy->AttachedDevHandle), phy->LinkRate)){
 221                                         printf("%s: failed to add device with "
 222                                             "handle 0x%x\n", __func__,
 223                                             le16toh(phy->AttachedDevHandle));
 224                                         mpssas_prepare_remove(sassc, le16toh(
 225                                                 phy->AttachedDevHandle));
 226                                 }
 227                                 break;
 228                         case MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING:
 229                                 mpssas_prepare_remove(sassc,le16toh(
 230                                         phy->AttachedDevHandle));
 231                                 break;
 232                         case MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED:
 233                         case MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE:
 234                         case MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING:
 235                         default:
 236                                 break;
 237                         }
 238                 }
 239                 /*
 240                  * refcount was incremented for this event in
 241                  * mpssas_evt_handler.  Decrement it here because the event has
 242                  * been processed.
 243                  */
 244                 mpssas_startup_decrement(sassc);
 245                 break;
 246         }
 247         case MPI2_EVENT_SAS_DISCOVERY:
 248         {
 249                 MPI2_EVENT_DATA_SAS_DISCOVERY *data;
 250
 251                 data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)fw_event->event_data;
 252
 253                 if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_STARTED)
 254                         mps_dprint(sc, MPS_TRACE,"SAS discovery start event\n");
 255                 if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_COMPLETED) {
 256                         mps_dprint(sc, MPS_TRACE,"SAS discovery stop event\n");
 257                         sassc->flags &= ~MPSSAS_IN_DISCOVERY;
 258                         mpssas_discovery_end(sassc);
 259                 }
 260                 break;
 261         }
 262         case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
 263         {
 264                 Mpi2EventDataSasEnclDevStatusChange_t *data;
 265                 data = (Mpi2EventDataSasEnclDevStatusChange_t *)
 266                     fw_event->event_data;
 267                 mps_mapping_enclosure_dev_status_change_event(sc,
 268                     fw_event->event_data);
 269                 break;
 270         }
 271         case MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST:
 272         {
 273                 Mpi2EventIrConfigElement_t *element;
 274                 int i;
 275                 u8 foreign_config;
 276                 Mpi2EventDataIrConfigChangeList_t *event_data;
 277                 struct mpssas_target *targ;
 278                 unsigned int id;
 279
 280                 event_data = fw_event->event_data;
 281                 foreign_config = (le32toh(event_data->Flags) &
 282                     MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG) ? 1 : 0;
 283
 284                 element =
 285                     (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
 286                 id = mps_mapping_get_raid_id_from_handle
 287                     (sc, element->VolDevHandle);
 288
 289                 mps_mapping_ir_config_change_event(sc, event_data);
 290
 291                 for (i = 0; i < event_data->NumElements; i++, element++) {
 292                         switch (element->ReasonCode) {
 293                         case MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED:
 294                         case MPI2_EVENT_IR_CHANGE_RC_ADDED:
 295                                 if (!foreign_config) {
 296                                         if (mpssas_volume_add(sc, le16toh(element->VolDevHandle))){
 297                                                 printf("%s: failed to add RAID "
 298                                                     "volume with handle 0x%x\n",
 299                                                     __func__, le16toh(element->
 300                                                     VolDevHandle));
 301                                         }
 302                                 }
 303                                 break;
 304                         case MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED:
 305                         case MPI2_EVENT_IR_CHANGE_RC_REMOVED:
 306                                 /*
 307                                  * Rescan after volume is deleted or removed.
 308                                  */
 309                                 if (!foreign_config) {
 310                                         if (id == MPS_MAP_BAD_ID) {
 311                                                 printf("%s: could not get ID "
 312                                                     "for volume with handle "
 313                                                     "0x%04x\n", __func__,
 314                                                     le16toh(element->VolDevHandle));
 315                                                 break;
 316                                         }
 317
 318                                         targ = &sassc->targets[id];
 319                                         targ->handle = 0x0;
 320                                         targ->encl_slot = 0x0;
 321                                         targ->encl_handle = 0x0;
 322                                         targ->exp_dev_handle = 0x0;
 323                                         targ->phy_num = 0x0;
 324                                         targ->linkrate = 0x0;
 325                                         mpssas_rescan_target(sc, targ);
 326                                         printf("RAID target id 0x%x removed\n",
 327                                             targ->tid);
 328                                 }
 329                                 break;
 330                         case MPI2_EVENT_IR_CHANGE_RC_PD_CREATED:
 331                         case MPI2_EVENT_IR_CHANGE_RC_HIDE:
 332                                 /*
 333                                  * Phys Disk of a volume has been created.  Hide
 334                                  * it from the OS.
 335                                  */
 336                                 targ = mpssas_find_target_by_handle(sassc, 0, element->PhysDiskDevHandle);
 337                                 if (targ == NULL)
 338                                         break;
 339
 340                                 /* Set raid component flags only if it is not WD.
 341                                  * OR WrapDrive with WD_HIDE_ALWAYS/WD_HIDE_IF_VOLUME is set in NVRAM
 342                                  */
 343                                 if((!sc->WD_available) ||
 344                                 ((sc->WD_available &&
 345                                 (sc->WD_hide_expose == MPS_WD_HIDE_ALWAYS)) ||
 346                                 (sc->WD_valid_config && (sc->WD_hide_expose ==
 347                                 MPS_WD_HIDE_IF_VOLUME)))) {
 348                                         targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
 349                                 }
 350                                 mpssas_rescan_target(sc, targ);
 351
 352                                 break;
 353                         case MPI2_EVENT_IR_CHANGE_RC_PD_DELETED:
 354                                 /*
 355                                  * Phys Disk of a volume has been deleted.
 356                                  * Expose it to the OS.
 357                                  */
 358                                 if (mpssas_add_device(sc,
 359                                     le16toh(element->PhysDiskDevHandle), 0)){
 360                                         printf("%s: failed to add device with "
 361                                             "handle 0x%x\n", __func__,
 362                                             le16toh(element->PhysDiskDevHandle));
 363                                         mpssas_prepare_remove(sassc, le16toh(element->
 364                                             PhysDiskDevHandle));
 365                                 }
 366                                 break;
 367                         }
 368                 }
 369                 /*
 370                  * refcount was incremented for this event in
 371                  * mpssas_evt_handler.  Decrement it here because the event has
 372                  * been processed.
 373                  */
 374                 mpssas_startup_decrement(sassc);
 375                 break;
 376         }
 377         case MPI2_EVENT_IR_VOLUME:
 378         {
 379                 Mpi2EventDataIrVolume_t *event_data = fw_event->event_data;
 380
 381                 /*
 382                  * Informational only.
 383                  */
 384                 mps_dprint(sc, MPS_EVENT, "Received IR Volume event:\n");
 385                 switch (event_data->ReasonCode) {
 386                 case MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED:
 387                         mps_dprint(sc, MPS_EVENT, "   Volume Settings "
 388                             "changed from 0x%x to 0x%x for Volome with "
 389                             "handle 0x%x", le32toh(event_data->PreviousValue),
 390                             le32toh(event_data->NewValue),
 391                             le16toh(event_data->VolDevHandle));
 392                         break;
 393                 case MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED:
 394                         mps_dprint(sc, MPS_EVENT, "   Volume Status "
 395                             "changed from 0x%x to 0x%x for Volome with "
 396                             "handle 0x%x", le32toh(event_data->PreviousValue),
 397                             le32toh(event_data->NewValue),
 398                             le16toh(event_data->VolDevHandle));
 399                         break;
 400                 case MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED:
 401                         mps_dprint(sc, MPS_EVENT, "   Volume State "
 402                             "changed from 0x%x to 0x%x for Volome with "
 403                             "handle 0x%x", le32toh(event_data->PreviousValue),
 404                             le32toh(event_data->NewValue),
 405                             le16toh(event_data->VolDevHandle));
 406                                 u32 state;
 407                                 struct mpssas_target *targ;
 408                                 state = le32toh(event_data->NewValue);
 409                                 switch (state) {
 410                                 case MPI2_RAID_VOL_STATE_MISSING:
 411                                 case MPI2_RAID_VOL_STATE_FAILED:
 412                                         mpssas_prepare_volume_remove(sassc, event_data->
 413                                                         VolDevHandle);
 414                                         break;
 415
 416                                 case MPI2_RAID_VOL_STATE_ONLINE:
 417                                 case MPI2_RAID_VOL_STATE_DEGRADED:
 418                                 case MPI2_RAID_VOL_STATE_OPTIMAL:
 419                                         targ = mpssas_find_target_by_handle(sassc, 0, event_data->VolDevHandle);
 420                                         if (targ) {
 421                                                 printf("%s %d: Volume handle 0x%x is already added \n",
 422                                                                 __func__, __LINE__ , event_data->VolDevHandle);
 423                                                 break;
 424                                         }
 425                                         if (mpssas_volume_add(sc, le16toh(event_data->VolDevHandle))) {
 426                                                 printf("%s: failed to add RAID "
 427                                                         "volume with handle 0x%x\n",
 428                                                         __func__, le16toh(event_data->
 429                                                         VolDevHandle));
 430                                         }
 431                                         break;
 432                                 default:
 433                                         break;
 434                                 }
 435                         break;
 436                 default:
 437                         break;
 438                 }
 439                 break;
 440         }
 441         case MPI2_EVENT_IR_PHYSICAL_DISK:
 442         {
 443                 Mpi2EventDataIrPhysicalDisk_t *event_data =
 444                     fw_event->event_data;
 445                 struct mpssas_target *targ;
 446
 447                 /*
 448                  * Informational only.
 449                  */
 450                 mps_dprint(sc, MPS_EVENT, "Received IR Phys Disk event:\n");
 451                 switch (event_data->ReasonCode) {
 452                 case MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED:
 453                         mps_dprint(sc, MPS_EVENT, "   Phys Disk Settings "
 454                             "changed from 0x%x to 0x%x for Phys Disk Number "
 455                             "%d and handle 0x%x at Enclosure handle 0x%x, Slot "
 456                             "%d", le32toh(event_data->PreviousValue),
 457                             le32toh(event_data->NewValue),
 458                                 event_data->PhysDiskNum,
 459                             le16toh(event_data->PhysDiskDevHandle),
 460                             le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
 461                         break;
 462                 case MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED:
 463                         mps_dprint(sc, MPS_EVENT, "   Phys Disk Status changed "
 464                             "from 0x%x to 0x%x for Phys Disk Number %d and "
 465                             "handle 0x%x at Enclosure handle 0x%x, Slot %d",
 466                                 le32toh(event_data->PreviousValue),
 467                             le32toh(event_data->NewValue), event_data->PhysDiskNum,
 468                             le16toh(event_data->PhysDiskDevHandle),
 469                             le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
 470                         break;
 471                 case MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED:
 472                         mps_dprint(sc, MPS_EVENT, "   Phys Disk State changed "
 473                             "from 0x%x to 0x%x for Phys Disk Number %d and "
 474                             "handle 0x%x at Enclosure handle 0x%x, Slot %d",
 475                                 le32toh(event_data->PreviousValue),
 476                             le32toh(event_data->NewValue), event_data->PhysDiskNum,
 477                             le16toh(event_data->PhysDiskDevHandle),
 478                             le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
 479                         switch (event_data->NewValue) {
 480                                 case MPI2_RAID_PD_STATE_ONLINE:
 481                                 case MPI2_RAID_PD_STATE_DEGRADED:
 482                                 case MPI2_RAID_PD_STATE_REBUILDING:
 483                                 case MPI2_RAID_PD_STATE_OPTIMAL:
 484                                 case MPI2_RAID_PD_STATE_HOT_SPARE:
 485                                         targ = mpssas_find_target_by_handle(sassc, 0,
 486                                                         event_data->PhysDiskDevHandle);
 487                                         if (targ) {
 488                                                 if(!sc->WD_available) {
 489                                                         targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
 490                                                         printf("%s %d: Found Target for handle 0x%x.  \n",
 491                                                         __func__, __LINE__ , event_data->PhysDiskDevHandle);
 492                                                 } else if ((sc->WD_available &&
 493                                                         (sc->WD_hide_expose == MPS_WD_HIDE_ALWAYS)) ||
 494                                                         (sc->WD_valid_config && (sc->WD_hide_expose ==
 495                                                         MPS_WD_HIDE_IF_VOLUME))) {
 496                                                         targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
 497                                                         printf("%s %d: WD: Found Target for handle 0x%x.  \n",
 498                                                         __func__, __LINE__ , event_data->PhysDiskDevHandle);
 499                                                 }
 500                                         }
 501                                 break;
 502                                 case MPI2_RAID_PD_STATE_OFFLINE:
 503                                 case MPI2_RAID_PD_STATE_NOT_CONFIGURED:
 504                                 case MPI2_RAID_PD_STATE_NOT_COMPATIBLE:
 505                                 default:
 506                                         targ = mpssas_find_target_by_handle(sassc, 0,
 507                                                         event_data->PhysDiskDevHandle);
 508                                         if (targ) {
 509                                                 targ->flags |= ~MPS_TARGET_FLAGS_RAID_COMPONENT;
 510                                                 printf("%s %d: Found Target for handle 0x%x.  \n",
 511                                                 __func__, __LINE__ , event_data->PhysDiskDevHandle);
 512                                         }
 513                                 break;
 514                         }
 515                 default:
 516                         break;
 517                 }
 518                 break;
 519         }
 520         case MPI2_EVENT_IR_OPERATION_STATUS:
 521         {
 522                 Mpi2EventDataIrOperationStatus_t *event_data =
 523                     fw_event->event_data;
 524
 525                 /*
 526                  * Informational only.
 527                  */
 528                 mps_dprint(sc, MPS_EVENT, "Received IR Op Status event:\n");
 529                 mps_dprint(sc, MPS_EVENT, "   RAID Operation of %d is %d "
 530                     "percent complete for Volume with handle 0x%x",
 531                     event_data->RAIDOperation, event_data->PercentComplete,
 532                     le16toh(event_data->VolDevHandle));
 533                 break;
 534         }
 535         case MPI2_EVENT_LOG_ENTRY_ADDED:
 536         {
 537                 pMpi2EventDataLogEntryAdded_t   logEntry;
 538                 uint16_t                        logQualifier;
 539                 uint8_t                         logCode;
 540
 541                 logEntry = (pMpi2EventDataLogEntryAdded_t)fw_event->event_data;
 542                 logQualifier = logEntry->LogEntryQualifier;
 543
 544                 if (logQualifier == MPI2_WD_LOG_ENTRY) {
 545                         logCode = logEntry->LogData[0];
 546
 547                         switch (logCode) {
 548                         case MPI2_WD_SSD_THROTTLING:
 549                                 printf("WarpDrive Warning: IO Throttling has "
 550                                     "occurred in the WarpDrive subsystem. "
 551                                     "Check WarpDrive documentation for "
 552                                     "additional details\n");
 553                                 break;
 554                         case MPI2_WD_DRIVE_LIFE_WARN:
 555                                 printf("WarpDrive Warning: Program/Erase "
 556                                     "Cycles for the WarpDrive subsystem in "
 557                                     "degraded range. Check WarpDrive "
 558                                     "documentation for additional details\n");
 559                                 break;
 560                         case MPI2_WD_DRIVE_LIFE_DEAD:
 561                                 printf("WarpDrive Fatal Error: There are no "
 562                                     "Program/Erase Cycles for the WarpDrive "
 563                                     "subsystem. The storage device will be in "
 564                                     "read-only mode. Check WarpDrive "
 565                                     "documentation for additional details\n");
 566                                 break;
 567                         case MPI2_WD_RAIL_MON_FAIL:
 568                                 printf("WarpDrive Fatal Error: The Backup Rail "
 569                                     "Monitor has failed on the WarpDrive "
 570                                     "subsystem. Check WarpDrive documentation "
 571                                     "for additional details\n");
 572                                 break;
 573                         default:
 574                                 break;
 575                         }
 576                 }
 577                 break;
 578         }
 579         case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
 580         case MPI2_EVENT_SAS_BROADCAST_PRIMITIVE:
 581         default:
 582                 mps_dprint(sc, MPS_TRACE,"Unhandled event 0x%0X\n",
 583                     fw_event->event);
 584                 break;
 585
 586         }
 587         mps_dprint(sc, MPS_EVENT, "(%d)->(%s) Event Free: [%x]\n",event_count,__func__, fw_event->event);
 588         mpssas_fw_event_free(sc, fw_event);
 589 }
 590
 591 void
 592 mpssas_firmware_event_work(void *arg, int pending)
 593 {
 594         struct mps_fw_event_work *fw_event;
 595         struct mps_softc *sc;
 596
 597         sc = (struct mps_softc *)arg;
 598         mps_lock(sc);
 599         while ((fw_event = TAILQ_FIRST(&sc->sassc->ev_queue)) != NULL) {
 600                 TAILQ_REMOVE(&sc->sassc->ev_queue, fw_event, ev_link);
 601                 mpssas_fw_work(sc, fw_event);
 602         }
 603         mps_unlock(sc);
 604 }
 605
 606 static int
 607 mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate){
 608         char devstring[80];
 609         struct mpssas_softc *sassc;
 610         struct mpssas_target *targ;
 611         Mpi2ConfigReply_t mpi_reply;
 612         Mpi2SasDevicePage0_t config_page;
 613         uint64_t sas_address;
 614         uint64_t parent_sas_address = 0;
 615         u32 device_info, parent_devinfo = 0;
 616         unsigned int id;
 617         int ret = 1, error = 0, i;
 618         struct mpssas_lun *lun;
 619         u8 is_SATA_SSD = 0;
 620         struct mps_command *cm;
 621
 622         sassc = sc->sassc;
 623         mpssas_startup_increment(sassc);
 624         if ((mps_config_get_sas_device_pg0(sc, &mpi_reply, &config_page,
 625              MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
 626                 printf("%s: error reading SAS device page0\n", __func__);
 627                 error = ENXIO;
 628                 goto out;
 629         }
 630
 631         device_info = le32toh(config_page.DeviceInfo);
 632
 633         if (((device_info & MPI2_SAS_DEVICE_INFO_SMP_TARGET) == 0)
 634          && (le16toh(config_page.ParentDevHandle) != 0)) {
 635                 Mpi2ConfigReply_t tmp_mpi_reply;
 636                 Mpi2SasDevicePage0_t parent_config_page;
 637
 638                 if ((mps_config_get_sas_device_pg0(sc, &tmp_mpi_reply,
 639                      &parent_config_page, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
 640                      le16toh(config_page.ParentDevHandle)))) {
 641                         printf("%s: error reading SAS device %#x page0\n",
 642                                __func__, le16toh(config_page.ParentDevHandle));
 643                 } else {
 644                         parent_sas_address = parent_config_page.SASAddress.High;
 645                         parent_sas_address = (parent_sas_address << 32) |
 646                                 parent_config_page.SASAddress.Low;
 647                         parent_devinfo = le32toh(parent_config_page.DeviceInfo);
 648                 }
 649         }
 650         /* TODO Check proper endianess */
 651         sas_address = config_page.SASAddress.High;
 652         sas_address = (sas_address << 32) | config_page.SASAddress.Low;
 653
 654         /*
 655          * Always get SATA Identify information because this is used to
 656          * determine if Start/Stop Unit should be sent to the drive when the
 657          * system is shutdown.
 658          */
 659         if (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE) {
 660                 ret = mpssas_get_sas_address_for_sata_disk(sc, &sas_address,
 661                     handle, device_info, &is_SATA_SSD);
 662                 if (ret) {
 663                         mps_dprint(sc, MPS_INFO, "%s: failed to get disk type "
 664                             "(SSD or HDD) for SATA device with handle 0x%04x\n",
 665                             __func__, handle);
 666                 } else {
 667                         mps_dprint(sc, MPS_INFO, "SAS Address from SATA "
 668                             "device = %jx\n", sas_address);
 669                 }
 670         }
 671
 672         /*
 673          * use_phynum:
 674          *  1 - use the PhyNum field as a fallback to the mapping logic
 675          *  0 - never use the PhyNum field
 676          * -1 - only use the PhyNum field
 677          */
 678         id = MPS_MAP_BAD_ID;
 679         if (sc->use_phynum != -1)
 680                 id = mps_mapping_get_sas_id(sc, sas_address, handle);
 681         if (id == MPS_MAP_BAD_ID) {
 682                 if ((sc->use_phynum == 0)
 683                  || ((id = config_page.PhyNum) > sassc->maxtargets)) {
 684                         mps_dprint(sc, MPS_INFO, "failure at %s:%d/%s()! "
 685                             "Could not get ID for device with handle 0x%04x\n",
 686                             __FILE__, __LINE__, __func__, handle);
 687                         error = ENXIO;
 688                         goto out;
 689                 }
 690         }
 691
 692         if (mpssas_check_id(sassc, id) != 0) {
 693                 device_printf(sc->mps_dev, "Excluding target id %d\n", id);
 694                 error = ENXIO;
 695                 goto out;
 696         }
 697
 698         targ = &sassc->targets[id];
 699         if (targ->handle != 0x0) {
 700                 mps_dprint(sc, MPS_MAPPING, "Attempting to reuse target id "
 701                     "%d handle 0x%04x\n", id, targ->handle);
 702                 error = ENXIO;
 703                 goto out;
 704         }
 705
 706         mps_dprint(sc, MPS_MAPPING, "SAS Address from SAS device page0 = %jx\n",
 707             sas_address);
 708         targ->devinfo = device_info;
 709         targ->devname = le32toh(config_page.DeviceName.High);
 710         targ->devname = (targ->devname << 32) |
 711             le32toh(config_page.DeviceName.Low);
 712         targ->encl_handle = le16toh(config_page.EnclosureHandle);
 713         targ->encl_slot = le16toh(config_page.Slot);
 714         targ->handle = handle;
 715         targ->parent_handle = le16toh(config_page.ParentDevHandle);
 716         targ->sasaddr = mps_to_u64(&config_page.SASAddress);
 717         targ->parent_sasaddr = le64toh(parent_sas_address);
 718         targ->parent_devinfo = parent_devinfo;
 719         targ->tid = id;
 720         targ->linkrate = (linkrate>>4);
 721         targ->flags = 0;
 722         if (is_SATA_SSD) {
 723                 targ->flags = MPS_TARGET_IS_SATA_SSD;
 724         }
 725         TAILQ_INIT(&targ->commands);
 726         TAILQ_INIT(&targ->timedout_commands);
 727         while(!SLIST_EMPTY(&targ->luns)) {
 728                 lun = SLIST_FIRST(&targ->luns);
 729                 SLIST_REMOVE_HEAD(&targ->luns, lun_link);
 730                 free(lun, M_MPT2);
 731         }
 732         SLIST_INIT(&targ->luns);
 733
 734         mps_describe_devinfo(targ->devinfo, devstring, 80);
 735         mps_dprint(sc, MPS_MAPPING, "Found device <%s> <%s> <0x%04x> <%d/%d>\n",
 736             devstring, mps_describe_table(mps_linkrate_names, targ->linkrate),
 737             targ->handle, targ->encl_handle, targ->encl_slot);
 738
 739 #if __FreeBSD_version < 1000039
 740         if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
 741 #endif
 742                 mpssas_rescan_target(sc, targ);
 743         mps_dprint(sc, MPS_MAPPING, "Target id 0x%x added\n", targ->tid);
 744
 745         /*
 746          * Check all commands to see if the SATA_ID_TIMEOUT flag has been set.
 747          * If so, send a Target Reset TM to the target that was just created.
 748          * An Abort Task TM should be used instead of a Target Reset, but that
 749          * would be much more difficult because targets have not been fully
 750          * discovered yet, and LUN's haven't been setup.  So, just reset the
 751          * target instead of the LUN.
 752          */
 753         for (i = 1; i < sc->num_reqs; i++) {
 754                 cm = &sc->commands[i];
 755                 if (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) {
 756                         targ->timeouts++;
 757                         cm->cm_state = MPS_CM_STATE_TIMEDOUT;
 758
 759                         if ((targ->tm = mpssas_alloc_tm(sc)) != NULL) {
 760                                 mps_dprint(sc, MPS_INFO, "%s: sending Target "
 761                                     "Reset for stuck SATA identify command "
 762                                     "(cm = %p)\n", __func__, cm);
 763                                 targ->tm->cm_targ = targ;
 764                                 mpssas_send_reset(sc, targ->tm,
 765                                     MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET);
 766                         } else {
 767                                 mps_dprint(sc, MPS_ERROR, "Failed to allocate "
 768                                     "tm for Target Reset after SATA ID command "
 769                                     "timed out (cm %p)\n", cm);
 770                         }
 771                         /*
 772                          * No need to check for more since the target is
 773                          * already being reset.
 774                          */
 775                         break;
 776                 }
 777         }
 778 out:
 779         /*
 780          * Free the commands that may not have been freed from the SATA ID call
 781          */
 782         for (i = 1; i < sc->num_reqs; i++) {
 783                 cm = &sc->commands[i];
 784                 if (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) {
 785                         mps_free_command(sc, cm);
 786                 }
 787         }
 788         mpssas_startup_decrement(sassc);
 789         return (error);
 790
 791 }
 792
 793 int
 794 mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
 795     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD)
 796 {
 797         Mpi2SataPassthroughReply_t mpi_reply;
 798         int i, rc, try_count;
 799         u32 *bufferptr;
 800         union _sata_sas_address hash_address;
 801         struct _ata_identify_device_data ata_identify;
 802         u8 buffer[MPT2SAS_MN_LEN + MPT2SAS_SN_LEN];
 803         u32 ioc_status;
 804         u8 sas_status;
 805
 806         memset(&ata_identify, 0, sizeof(ata_identify));
 807         try_count = 0;
 808         do {
 809                 rc = mpssas_get_sata_identify(sc, handle, &mpi_reply,
 810                     (char *)&ata_identify, sizeof(ata_identify), device_info);
 811                 try_count++;
 812                 ioc_status = le16toh(mpi_reply.IOCStatus)
 813                     & MPI2_IOCSTATUS_MASK;
 814                 sas_status = mpi_reply.SASStatus;
 815                 switch (ioc_status) {
 816                 case MPI2_IOCSTATUS_SUCCESS:
 817                         break;
 818                 case MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR:
 819                         /* No sense sleeping.  this error won't get better */
 820                         break;
 821                 default:
 822                         if (sc->spinup_wait_time > 0) {
 823                                 mps_dprint(sc, MPS_INFO, "Sleeping %d seconds "
 824                                     "after SATA ID error to wait for spinup\n",
 825                                     sc->spinup_wait_time);
 826                                 msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
 827                                     "mpsid", sc->spinup_wait_time * hz);
 828                         }
 829                 }
 830         } while (((rc && (rc != EWOULDBLOCK)) ||
 831                  (ioc_status &&
 832                   (ioc_status != MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR))
 833                || sas_status) && (try_count < 5));
 834
 835         if (rc == 0 && !ioc_status && !sas_status) {
 836                 mps_dprint(sc, MPS_MAPPING, "%s: got SATA identify "
 837                     "successfully for handle = 0x%x with try_count = %d\n",
 838                     __func__, handle, try_count);
 839         } else {
 840                 mps_dprint(sc, MPS_MAPPING, "%s: handle = 0x%x failed\n",
 841                     __func__, handle);
 842                 return -1;
 843         }
 844         /* Copy & byteswap the 40 byte model number to a buffer */
 845         for (i = 0; i < MPT2SAS_MN_LEN; i += 2) {
 846                 buffer[i] = ((u8 *)ata_identify.model_number)[i + 1];
 847                 buffer[i + 1] = ((u8 *)ata_identify.model_number)[i];
 848         }
 849         /* Copy & byteswap the 20 byte serial number to a buffer */
 850         for (i = 0; i < MPT2SAS_SN_LEN; i += 2) {
 851                 buffer[MPT2SAS_MN_LEN + i] =
 852                     ((u8 *)ata_identify.serial_number)[i + 1];
 853                 buffer[MPT2SAS_MN_LEN + i + 1] =
 854                     ((u8 *)ata_identify.serial_number)[i];
 855         }
 856         bufferptr = (u32 *)buffer;
 857         /* There are 60 bytes to hash down to 8. 60 isn't divisible by 8,
 858          * so loop through the first 56 bytes (7*8),
 859          * and then add in the last dword.
 860          */
 861         hash_address.word.low  = 0;
 862         hash_address.word.high = 0;
 863         for (i = 0; (i < ((MPT2SAS_MN_LEN+MPT2SAS_SN_LEN)/8)); i++) {
 864                 hash_address.word.low += *bufferptr;
 865                 bufferptr++;
 866                 hash_address.word.high += *bufferptr;
 867                 bufferptr++;
 868         }
 869         /* Add the last dword */
 870         hash_address.word.low += *bufferptr;
 871         /* Make sure the hash doesn't start with 5, because it could clash
 872          * with a SAS address. Change 5 to a D.
 873          */
 874         if ((hash_address.word.high & 0x000000F0) == (0x00000050))
 875                 hash_address.word.high |= 0x00000080;
 876         *sas_address = (u64)hash_address.wwid[0] << 56 |
 877             (u64)hash_address.wwid[1] << 48 | (u64)hash_address.wwid[2] << 40 |
 878             (u64)hash_address.wwid[3] << 32 | (u64)hash_address.wwid[4] << 24 |
 879             (u64)hash_address.wwid[5] << 16 | (u64)hash_address.wwid[6] <<  8 |
 880             (u64)hash_address.wwid[7];
 881         if (ata_identify.rotational_speed == 1) {
 882                 *is_SATA_SSD = 1;
 883         }
 884
 885         return 0;
 886 }
 887
 888 static int
 889 mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
 890     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz, u32 devinfo)
 891 {
 892         Mpi2SataPassthroughRequest_t *mpi_request;
 893         Mpi2SataPassthroughReply_t *reply;
 894         struct mps_command *cm;
 895         char *buffer;
 896         int error = 0;
 897
 898         buffer = malloc( sz, M_MPT2, M_NOWAIT | M_ZERO);
 899         if (!buffer)
 900                 return ENOMEM;
 901
 902         if ((cm = mps_alloc_command(sc)) == NULL) {
 903                 free(buffer, M_MPT2);
 904                 return (EBUSY);
 905         }
 906         mpi_request = (MPI2_SATA_PASSTHROUGH_REQUEST *)cm->cm_req;
 907         bzero(mpi_request,sizeof(MPI2_SATA_PASSTHROUGH_REQUEST));
 908         mpi_request->Function = MPI2_FUNCTION_SATA_PASSTHROUGH;
 909         mpi_request->VF_ID = 0;
 910         mpi_request->DevHandle = htole16(handle);
 911         mpi_request->PassthroughFlags = (MPI2_SATA_PT_REQ_PT_FLAGS_PIO |
 912             MPI2_SATA_PT_REQ_PT_FLAGS_READ);
 913         mpi_request->DataLength = htole32(sz);
 914         mpi_request->CommandFIS[0] = 0x27;
 915         mpi_request->CommandFIS[1] = 0x80;
 916         mpi_request->CommandFIS[2] =  (devinfo &
 917             MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? 0xA1 : 0xEC;
 918         cm->cm_sge = &mpi_request->SGL;
 919         cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
 920         cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE | MPS_CM_FLAGS_DATAIN;
 921         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
 922         cm->cm_data = buffer;
 923         cm->cm_length = htole32(sz);
 924
 925         /*
 926          * Start a timeout counter specifically for the SATA ID command. This
 927          * is used to fix a problem where the FW does not send a reply sometimes
 928          * when a bad disk is in the topology. So, this is used to timeout the
 929          * command so that processing can continue normally.
 930          */
 931         mps_dprint(sc, MPS_XINFO, "%s start timeout counter for SATA ID "
 932             "command\n", __func__);
 933         callout_reset(&cm->cm_callout, MPS_ATA_ID_TIMEOUT * hz,
 934             mpssas_ata_id_timeout, cm);
 935         error = mps_wait_command(sc, cm, 60, CAN_SLEEP);
 936         mps_dprint(sc, MPS_XINFO, "%s stop timeout counter for SATA ID "
 937             "command\n", __func__);
 938         callout_stop(&cm->cm_callout);
 939
 940         reply = (Mpi2SataPassthroughReply_t *)cm->cm_reply;
 941         if (error || (reply == NULL)) {
 942                 /* FIXME */
 943                 /*
 944                  * If the request returns an error then we need to do a diag
 945                  * reset
 946                  */
 947                 printf("%s: request for page completed with error %d",
 948                     __func__, error);
 949                 error = ENXIO;
 950                 goto out;
 951         }
 952         bcopy(buffer, id_buffer, sz);
 953         bcopy(reply, mpi_reply, sizeof(Mpi2SataPassthroughReply_t));
 954         if ((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
 955             MPI2_IOCSTATUS_SUCCESS) {
 956                 printf("%s: error reading SATA PASSTHRU; iocstatus = 0x%x\n",
 957                     __func__, reply->IOCStatus);
 958                 error = ENXIO;
 959                 goto out;
 960         }
 961 out:
 962         /*
 963          * If the SATA_ID_TIMEOUT flag has been set for this command, don't free
 964          * it.  The command will be freed after sending a target reset TM. If
 965          * the command did timeout, use EWOULDBLOCK.
 966          */
 967         if ((cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) == 0)
 968                 mps_free_command(sc, cm);
 969         else if (error == 0)
 970                 error = EWOULDBLOCK;
 971         free(buffer, M_MPT2);
 972         return (error);
 973 }
 974
 975 static void
 976 mpssas_ata_id_timeout(void *data)
 977 {
 978         struct mps_softc *sc;
 979         struct mps_command *cm;
 980
 981         cm = (struct mps_command *)data;
 982         sc = cm->cm_sc;
 983         mtx_assert(&sc->mps_mtx, MA_OWNED);
 984
 985         mps_dprint(sc, MPS_INFO, "%s checking ATA ID command %p sc %p\n",
 986             __func__, cm, sc);
 987         if ((callout_pending(&cm->cm_callout)) ||
 988             (!callout_active(&cm->cm_callout))) {
 989                 mps_dprint(sc, MPS_INFO, "%s ATA ID command almost timed out\n",
 990                     __func__);
 991                 return;
 992         }
 993         callout_deactivate(&cm->cm_callout);
 994
 995         /*
 996          * Run the interrupt handler to make sure it's not pending.  This
 997          * isn't perfect because the command could have already completed
 998          * and been re-used, though this is unlikely.
 999          */
1000         mps_intr_locked(sc);
1001         if (cm->cm_state == MPS_CM_STATE_FREE) {
1002                 mps_dprint(sc, MPS_INFO, "%s ATA ID command almost timed out\n",
1003                     __func__);
1004                 return;
1005         }
1006
1007         mps_dprint(sc, MPS_INFO, "ATA ID command timeout cm %p\n", cm);
1008
1009         /*
1010          * Send wakeup() to the sleeping thread that issued this ATA ID command.
1011          * wakeup() will cause msleep to return a 0 (not EWOULDBLOCK), and this
1012          * will keep reinit() from being called. This way, an Abort Task TM can
1013          * be issued so that the timed out command can be cleared.  The Abort
1014          * Task cannot be sent from here because the driver has not completed
1015          * setting up targets.  Instead, the command is flagged so that special
1016          * handling will be used to send the abort.
1017          */
1018         cm->cm_flags |= MPS_CM_FLAGS_SATA_ID_TIMEOUT;
1019         wakeup(cm);
1020 }
1021
1022 static int
1023 mpssas_volume_add(struct mps_softc *sc, u16 handle)
1024 {
1025         struct mpssas_softc *sassc;
1026         struct mpssas_target *targ;
1027         u64 wwid;
1028         unsigned int id;
1029         int error = 0;
1030         struct mpssas_lun *lun;
1031
1032         sassc = sc->sassc;
1033         mpssas_startup_increment(sassc);
1034         /* wwid is endian safe */
1035         mps_config_get_volume_wwid(sc, handle, &wwid);
1036         if (!wwid) {
1037                 printf("%s: invalid WWID; cannot add volume to mapping table\n",
1038                     __func__);
1039                 error = ENXIO;
1040                 goto out;
1041         }
1042
1043         id = mps_mapping_get_raid_id(sc, wwid, handle);
1044         if (id == MPS_MAP_BAD_ID) {
1045                 printf("%s: could not get ID for volume with handle 0x%04x and "
1046                     "WWID 0x%016llx\n", __func__, handle,
1047                     (unsigned long long)wwid);
1048                 error = ENXIO;
1049                 goto out;
1050         }
1051
1052         targ = &sassc->targets[id];
1053         targ->tid = id;
1054         targ->handle = handle;
1055         targ->devname = wwid;
1056         TAILQ_INIT(&targ->commands);
1057         TAILQ_INIT(&targ->timedout_commands);
1058         while(!SLIST_EMPTY(&targ->luns)) {
1059                 lun = SLIST_FIRST(&targ->luns);
1060                 SLIST_REMOVE_HEAD(&targ->luns, lun_link);
1061                 free(lun, M_MPT2);
1062         }
1063         SLIST_INIT(&targ->luns);
1064 #if __FreeBSD_version < 1000039
1065         if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
1066 #endif
1067                 mpssas_rescan_target(sc, targ);
1068         mps_dprint(sc, MPS_MAPPING, "RAID target id %d added (WWID = 0x%jx)\n",
1069             targ->tid, wwid);
1070 out:
1071         mpssas_startup_decrement(sassc);
1072         return (error);
1073 }
1074
1075 /**
1076  * mpssas_SSU_to_SATA_devices
1077  * @sc: per adapter object
1078  *
1079  * Looks through the target list and issues a StartStopUnit SCSI command to each
1080  * SATA direct-access device.  This helps to ensure that data corruption is
1081  * avoided when the system is being shut down.  This must be called after the IR
1082  * System Shutdown RAID Action is sent if in IR mode.
1083  *
1084  * Return nothing.
1085  */
1086 static void
1087 mpssas_SSU_to_SATA_devices(struct mps_softc *sc)
1088 {
1089         struct mpssas_softc *sassc = sc->sassc;
1090         union ccb *ccb;
1091         path_id_t pathid = cam_sim_path(sassc->sim);
1092         target_id_t targetid;
1093         struct mpssas_target *target;
1094         char path_str[64];
1095         struct timeval cur_time, start_time;
1096
1097         /*
1098          * For each target, issue a StartStopUnit command to stop the device.
1099          */
1100         sc->SSU_started = TRUE;
1101         sc->SSU_refcount = 0;
1102         for (targetid = 0; targetid < sc->facts->MaxTargets; targetid++) {
1103                 target = &sassc->targets[targetid];
1104                 if (target->handle == 0x0) {
1105                         continue;
1106                 }
1107
1108                 ccb = xpt_alloc_ccb_nowait();
1109                 if (ccb == NULL) {
1110                         mps_dprint(sc, MPS_FAULT, "Unable to alloc CCB to stop "
1111                             "unit.\n");
1112                         return;
1113                 }
1114
1115                 /*
1116                  * The stop_at_shutdown flag will be set if this device is
1117                  * a SATA direct-access end device.
1118                  */
1119                 if (target->stop_at_shutdown) {
1120                         if (xpt_create_path(&ccb->ccb_h.path,
1121                             xpt_periph, pathid, targetid,
1122                             CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
1123                                 mps_dprint(sc, MPS_FAULT, "Unable to create "
1124                                     "LUN path to stop unit.\n");
1125                                 xpt_free_ccb(ccb);
1126                                 return;
1127                         }
1128                         xpt_path_string(ccb->ccb_h.path, path_str,
1129                             sizeof(path_str));
1130
1131                         mps_dprint(sc, MPS_INFO, "Sending StopUnit: path %s "
1132                             "handle %d\n", path_str, target->handle);
1133
1134                         /*
1135                          * Issue a START STOP UNIT command for the target.
1136                          * Increment the SSU counter to be used to count the
1137                          * number of required replies.
1138                          */
1139                         mps_dprint(sc, MPS_INFO, "Incrementing SSU count\n");
1140                         sc->SSU_refcount++;
1141                         ccb->ccb_h.target_id =
1142                             xpt_path_target_id(ccb->ccb_h.path);
1143                         ccb->ccb_h.ppriv_ptr1 = sassc;
1144                         scsi_start_stop(&ccb->csio,
1145                             /*retries*/0,
1146                             mpssas_stop_unit_done,
1147                             MSG_SIMPLE_Q_TAG,
1148                             /*start*/FALSE,
1149                             /*load/eject*/0,
1150                             /*immediate*/FALSE,
1151                             MPS_SENSE_LEN,
1152                             /*timeout*/10000);
1153                         xpt_action(ccb);
1154                 }
1155         }
1156
1157         /*
1158          * Wait until all of the SSU commands have completed or time has
1159          * expired (60 seconds).  Pause for 100ms each time through.  If any
1160          * command times out, the target will be reset in the SCSI command
1161          * timeout routine.
1162          */
1163         getmicrotime(&start_time);
1164         while (sc->SSU_refcount) {
1165                 pause("mpswait", hz/10);
1166
1167                 getmicrotime(&cur_time);
1168                 if ((cur_time.tv_sec - start_time.tv_sec) > 60) {
1169                         mps_dprint(sc, MPS_FAULT, "Time has expired waiting "
1170                             "for SSU commands to complete.\n");
1171                         break;
1172                 }
1173         }
1174 }
1175
1176 static void
1177 mpssas_stop_unit_done(struct cam_periph *periph, union ccb *done_ccb)
1178 {
1179         struct mpssas_softc *sassc;
1180         char path_str[64];
1181
1182         if (done_ccb == NULL)
1183                 return;
1184
1185         sassc = (struct mpssas_softc *)done_ccb->ccb_h.ppriv_ptr1;
1186
1187         xpt_path_string(done_ccb->ccb_h.path, path_str, sizeof(path_str));
1188         mps_dprint(sassc->sc, MPS_INFO, "Completing stop unit for %s\n",
1189             path_str);
1190
1191         /*
1192          * Nothing more to do except free the CCB and path.  If the command
1193          * timed out, an abort reset, then target reset will be issued during
1194          * the SCSI Command process.
1195          */
1196         xpt_free_path(done_ccb->ccb_h.path);
1197         xpt_free_ccb(done_ccb);
1198 }
1199
1200 /**
1201  * mpssas_ir_shutdown - IR shutdown notification
1202  * @sc: per adapter object
1203  *
1204  * Sending RAID Action to alert the Integrated RAID subsystem of the IOC that
1205  * the host system is shutting down.
1206  *
1207  * Return nothing.
1208  */
1209 void
1210 mpssas_ir_shutdown(struct mps_softc *sc)
1211 {
1212         u16 volume_mapping_flags;
1213         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1214         struct dev_mapping_table *mt_entry;
1215         u32 start_idx, end_idx;
1216         unsigned int id, found_volume = 0;
1217         struct mps_command *cm;
1218         Mpi2RaidActionRequest_t *action;
1219         target_id_t targetid;
1220         struct mpssas_target *target;
1221
1222         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
1223
1224         /* is IR firmware build loaded? */
1225         if (!sc->ir_firmware)
1226                 goto out;
1227
1228         /* are there any volumes?  Look at IR target IDs. */
1229         // TODO-later, this should be looked up in the RAID config structure
1230         // when it is implemented.
1231         volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
1232             MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
1233         if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
1234                 start_idx = 0;
1235                 if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
1236                         start_idx = 1;
1237         } else
1238                 start_idx = sc->max_devices - sc->max_volumes;
1239         end_idx = start_idx + sc->max_volumes - 1;
1240
1241         for (id = start_idx; id < end_idx; id++) {
1242                 mt_entry = &sc->mapping_table[id];
1243                 if ((mt_entry->physical_id != 0) &&
1244                     (mt_entry->missing_count == 0)) {
1245                         found_volume = 1;
1246                         break;
1247                 }
1248         }
1249
1250         if (!found_volume)
1251                 goto out;
1252
1253         if ((cm = mps_alloc_command(sc)) == NULL) {
1254                 printf("%s: command alloc failed\n", __func__);
1255                 goto out;
1256         }
1257
1258         action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
1259         action->Function = MPI2_FUNCTION_RAID_ACTION;
1260         action->Action = MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED;
1261         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1262         mps_lock(sc);
1263         mps_wait_command(sc, cm, 5, CAN_SLEEP);
1264         mps_unlock(sc);
1265
1266         /*
1267          * Don't check for reply, just leave.
1268          */
1269         if (cm)
1270                 mps_free_command(sc, cm);
1271
1272 out:
1273         /*
1274          * All of the targets must have the correct value set for
1275          * 'stop_at_shutdown' for the current 'enable_ssu' sysctl variable.
1276          *
1277          * The possible values for the 'enable_ssu' variable are:
1278          * 0: disable to SSD and HDD
1279          * 1: disable only to HDD (default)
1280          * 2: disable only to SSD
1281          * 3: enable to SSD and HDD
1282          * anything else will default to 1.
1283          */
1284         for (targetid = 0; targetid < sc->facts->MaxTargets; targetid++) {
1285                 target = &sc->sassc->targets[targetid];
1286                 if (target->handle == 0x0) {
1287                         continue;
1288                 }
1289
1290                 if (target->supports_SSU) {
1291                         switch (sc->enable_ssu) {
1292                         case MPS_SSU_DISABLE_SSD_DISABLE_HDD:
1293                                 target->stop_at_shutdown = FALSE;
1294                                 break;
1295                         case MPS_SSU_DISABLE_SSD_ENABLE_HDD:
1296                                 target->stop_at_shutdown = TRUE;
1297                                 if (target->flags & MPS_TARGET_IS_SATA_SSD) {
1298                                         target->stop_at_shutdown = FALSE;
1299                                 }
1300                                 break;
1301                         case MPS_SSU_ENABLE_SSD_ENABLE_HDD:
1302                                 target->stop_at_shutdown = TRUE;
1303                                 break;
1304                         case MPS_SSU_ENABLE_SSD_DISABLE_HDD:
1305                         default:
1306                                 target->stop_at_shutdown = TRUE;
1307                                 if ((target->flags &
1308                                     MPS_TARGET_IS_SATA_SSD) == 0) {
1309                                         target->stop_at_shutdown = FALSE;
1310                                 }
1311                                 break;
1312                         }
1313                 }
1314         }
1315         mpssas_SSU_to_SATA_devices(sc);
1316 }