freebsd-dev/sys/dev/isci/scil/scif_sas_task_request_states.c
Pedro F. Giffuni 718cf2ccb9 sys/dev: further adoption of SPDX licensing ID tags.
Mainly focus on files that use BSD 2-Clause license, however the tool I
was using misidentified many licenses so this was mostly a manual - error
prone - task.

The Software Package Data Exchange (SPDX) group provides a specification
to make it easier for automated tools to detect and summarize well known
opensource licenses. We are gradually adopting the specification, noting
that the tags are considered only advisory and do not, in any way,
superceed or replace the license texts.
2017-11-27 14:52:40 +00:00

290 lines
8.9 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
*
* This file is provided under a dual BSD/GPLv2 license. When using or
* redistributing this file, you may do so under either license.
*
* GPL LICENSE SUMMARY
*
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
* The full GNU General Public License is included in this distribution
* in the file called LICENSE.GPL.
*
* BSD LICENSE
*
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
/**
* @file
*
* @brief This file contains all of the SCIF_SAS_TASK_REQUEST object
* state entrance and exit method implementations.
*/
#include <dev/isci/scil/scif_sas_task_request.h>
//******************************************************************************
//* P R O T E C T E D M E T H O D S
//******************************************************************************
/**
* @brief This method implements the actions taken when entering the
* INITIAL state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_initial_state_enter(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_TASK_REQUEST_T * fw_task = (SCIF_SAS_TASK_REQUEST_T *)object;
SET_STATE_HANDLER(
&fw_task->parent,
scif_sas_task_request_state_handler_table,
SCI_BASE_REQUEST_STATE_INITIAL
);
// Initial state is a transitional state to the constructed state
sci_base_state_machine_change_state(
&fw_task->parent.parent.state_machine, SCI_BASE_REQUEST_STATE_CONSTRUCTED
);
}
/**
* @brief This method implements the actions taken when entering the
* CONSTRUCTED state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_constructed_state_enter(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_TASK_REQUEST_T * fw_task = (SCIF_SAS_TASK_REQUEST_T *)object;
SET_STATE_HANDLER(
&fw_task->parent,
scif_sas_task_request_state_handler_table,
SCI_BASE_REQUEST_STATE_CONSTRUCTED
);
}
/**
* @brief This method implements the actions taken when entering the
* STARTED state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_started_state_enter(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_TASK_REQUEST_T * fw_task = (SCIF_SAS_TASK_REQUEST_T *)object;
SET_STATE_HANDLER(
&fw_task->parent,
scif_sas_task_request_state_handler_table,
SCI_BASE_REQUEST_STATE_STARTED
);
// Increment the affected request count to include the task performing
// the task management to ensure we don't complete the task request until
// all terminations and the task itself have completed.
fw_task->affected_request_count++;
}
/**
* @brief This method implements the actions taken when entering the
* COMPLETED state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_completed_state_enter(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_TASK_REQUEST_T * fw_task = (SCIF_SAS_TASK_REQUEST_T *)object;
SET_STATE_HANDLER(
&fw_task->parent,
scif_sas_task_request_state_handler_table,
SCI_BASE_REQUEST_STATE_COMPLETED
);
// Check to see if the task management operation is now finished (i.e.
// all of the task terminations and the task management request are
// complete).
scif_sas_task_request_operation_complete(fw_task);
}
/**
* @brief This method implements the actions taken when entering the
* ABORTING state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_aborting_state_enter(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_TASK_REQUEST_T * fw_task = (SCIF_SAS_TASK_REQUEST_T *)object;
SET_STATE_HANDLER(
&fw_task->parent,
scif_sas_task_request_state_handler_table,
SCI_BASE_REQUEST_STATE_ABORTING
);
/// @todo Is terminating a previously outstanding task request right?
fw_task->parent.status = scif_sas_request_terminate_start(
&fw_task->parent, fw_task->parent.core_object
);
}
/**
* @brief This method implements the actions taken when exiting the
* ABORTING state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_aborting_state_exit(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_REQUEST_T * fw_request = (SCIF_SAS_REQUEST_T *)object;
scif_sas_request_terminate_complete(fw_request);
}
/**
* @brief This method implements the actions taken when entering the
* FINAL state.
*
* @param[in] object This parameter specifies the base object for which
* the state transition is occurring. This is cast into a
* SCIF_SAS_TASK_REQUEST object in the method implementation.
*
* @return none
*/
static
void scif_sas_task_request_final_state_enter(
SCI_BASE_OBJECT_T *object
)
{
SCIF_SAS_TASK_REQUEST_T * fw_task = (SCIF_SAS_TASK_REQUEST_T *)object;
SET_STATE_HANDLER(
&fw_task->parent,
scif_sas_task_request_state_handler_table,
SCI_BASE_REQUEST_STATE_FINAL
);
}
SCI_BASE_STATE_T
scif_sas_task_request_state_table[SCI_BASE_REQUEST_MAX_STATES] =
{
{
SCI_BASE_REQUEST_STATE_INITIAL,
scif_sas_task_request_initial_state_enter,
NULL
},
{
SCI_BASE_REQUEST_STATE_CONSTRUCTED,
scif_sas_task_request_constructed_state_enter,
NULL
},
{
SCI_BASE_REQUEST_STATE_STARTED,
scif_sas_task_request_started_state_enter,
NULL
},
{
SCI_BASE_REQUEST_STATE_COMPLETED,
scif_sas_task_request_completed_state_enter,
NULL
},
{
SCI_BASE_REQUEST_STATE_ABORTING,
scif_sas_task_request_aborting_state_enter,
scif_sas_task_request_aborting_state_exit
},
{
SCI_BASE_REQUEST_STATE_FINAL,
scif_sas_task_request_final_state_enter,
NULL
},
};