2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
56 #ifndef _SCIF_SAS_TASK_REQUEST_H_
57 #define _SCIF_SAS_TASK_REQUEST_H_
62 * @brief This file contains the protected interface structures, constants,
63 * and methods for the SCIF_SAS_TASK_REQUEST object.
70 #include <dev/isci/scil/sati_translator_sequence.h>
71 #include <dev/isci/scil/scif_task_request.h>
72 #include <dev/isci/scil/sci_base_request.h>
73 #include <dev/isci/scil/scif_sas_request.h>
74 #include <dev/isci/scil/scif_sas_internal_io_request.h>
75 #include <dev/isci/scil/intel_sas.h>
78 * @struct SCIF_SAS_TASK_REQUEST
80 * @brief The SCI SAS Framework Task request object abstracts the SAS task
81 * management behavior for the framework component. Additionally,
82 * it provides a higher level of abstraction for the core task
85 typedef struct SCIF_SAS_TASK_REQUEST
88 * The SCIF_SAS_REQUEST is the parent object for the
89 * SCIF_SAS_TASK_REQUEST object.
91 SCIF_SAS_REQUEST_T parent;
94 * This field contains the number of current requests affected by
95 * this task management request. This number indicates all of the
96 * requests terminated in the silicon (including previous task requests).
98 U16 affected_request_count;
101 * This field specifies the tag for the IO request or the tag to be
102 * managed for a task management request.
103 * This field is utilized during internal IO requests.
105 U16 io_tag_to_manage;
108 * This field will be utilized to specify the task management function
109 * of this task request.
111 SCI_SAS_TASK_MGMT_FUNCTION_T function;
113 } SCIF_SAS_TASK_REQUEST_T;
115 extern SCI_BASE_STATE_T scif_sas_task_request_state_table[];
116 extern SCI_BASE_REQUEST_STATE_HANDLER_T
117 scif_sas_task_request_state_handler_table[];
119 void scif_sas_task_request_operation_complete(
120 SCIF_SAS_TASK_REQUEST_T * fw_task
123 U8 scif_sas_task_request_get_function(
124 SCIF_SAS_TASK_REQUEST_T * fw_task
127 SCI_STATUS scif_sas_internal_task_request_construct(
128 SCI_CONTROLLER_HANDLE_T scif_controller,
129 SCI_REMOTE_DEVICE_HANDLE_T scif_remote_device,
131 void * task_request_memory,
132 SCI_TASK_REQUEST_HANDLE_T * scif_task_request,
136 void scif_sas_internal_task_request_destruct(
137 SCIF_SAS_TASK_REQUEST_T * fw_internal_task
142 #endif // __cplusplus
144 #endif // _SCIF_SAS_TASK_REQUEST_H_