sys/dev/isci/scil/scif_sas_remote_device_starting_substates.c

   1 /*-
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  41  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  42  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  43  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  44  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  46  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  48  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  49  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  50  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51  */
  52
  53 #include <sys/cdefs.h>
  54 __FBSDID("$FreeBSD$");
  55
  56 /**
  57  * @file
  58  *
  59  * @brief This file contains the entrance and exit methods for the starting
  60  *        sub-state machine states (AWAIT COMPELTE).  The starting sub-state
  61  *        machine manages the steps necessary to initialize and configure
  62  *        a remote device.
  63  */
  64
  65 #include <dev/isci/scil/scif_sas_remote_device.h>
  66 #include <dev/isci/scil/scif_sas_domain.h>
  67 #include <dev/isci/scil/scif_sas_logger.h>
  68
  69
  70 //******************************************************************************
  71 //* P R O T E C T E D   M E T H O D S
  72 //******************************************************************************
  73
  74 /**
  75  * @brief This method implements the actions taken when entering the
  76  *        STARTING AWAIT COMPLETE substate.  This includes setting the
  77  *        state handler methods.
  78  *
  79  * @param[in]  object This parameter specifies the base object for which
  80  *             the state transition is occurring.  This is cast into a
  81  *             SCIF_SAS_REMOTE_DEVICE object in the method implementation.
  82  *
  83  * @return none
  84  */
  85 static
  86 void scif_sas_remote_device_starting_await_complete_substate_enter(
  87    SCI_BASE_OBJECT_T *object
  88 )
  89 {
  90    SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T *)object;
  91
  92    SET_STATE_HANDLER(
  93       fw_device,
  94       scif_sas_remote_device_starting_substate_handler_table,
  95       SCIF_SAS_REMOTE_DEVICE_STARTING_SUBSTATE_AWAIT_COMPLETE
  96    );
  97
  98    fw_device->domain->device_start_in_progress_count++;
  99    fw_device->domain->device_start_count++;
 100 }
 101
 102 /**
 103  * @brief This method implements the actions taken when entering the
 104  *        STARTING COMPLETE substate.  This includes setting the
 105  *        state handler methods.
 106  *
 107  * @param[in]  object This parameter specifies the base object for which
 108  *             the state transition is occurring.  This is cast into a
 109  *             SCIF_SAS_REMOTE_DEVICE object in the method implementation.
 110  *
 111  * @return none
 112  */
 113 static
 114 void scif_sas_remote_device_starting_complete_substate_enter(
 115    SCI_BASE_OBJECT_T *object
 116 )
 117 {
 118    SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T *)object;
 119
 120    SET_STATE_HANDLER(
 121       fw_device,
 122       scif_sas_remote_device_starting_substate_handler_table,
 123       SCIF_SAS_REMOTE_DEVICE_STARTING_SUBSTATE_AWAIT_READY
 124    );
 125 }
 126
 127
 128 SCI_BASE_STATE_T
 129 scif_sas_remote_device_starting_substate_table
 130 [SCIF_SAS_REMOTE_DEVICE_STARTING_SUBSTATE_MAX_STATES] =
 131 {
 132    {
 133       SCIF_SAS_REMOTE_DEVICE_STARTING_SUBSTATE_AWAIT_COMPLETE,
 134       scif_sas_remote_device_starting_await_complete_substate_enter,
 135       NULL
 136    },
 137    {
 138       SCIF_SAS_REMOTE_DEVICE_STARTING_SUBSTATE_AWAIT_READY,
 139       scif_sas_remote_device_starting_complete_substate_enter,
 140       NULL
 141    }
 142 };
 143