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