xref: /freebsd/sys/dev/isci/scil/scif_sas_stp_task_request.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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 #ifndef _SCIF_SAS_STP_TASK_REQUEST_H_
55 #define _SCIF_SAS_STP_TASK_REQUEST_H_
56 
57 /**
58  * @file
59  *
60  * @brief This file contains the protected interface structures, constants,
61  *        and methods for the SCIF_SAS_STP_TASK_REQUEST object.
62  */
63 
64 #ifdef __cplusplus
65 extern "C" {
66 #endif // __cplusplus
67 
68 #include <dev/isci/scil/sati_translator_sequence.h>
69 #include <dev/isci/scil/sci_types.h>
70 #include <dev/isci/scil/sci_status.h>
71 
72 /**
73  * @struct SCIF_SAS_STP_TASK_REQUEST
74  *
75  * @brief This structure contains all of the data specific to performing
76  *        SATA/STP IO requests.
77  */
78 typedef struct SCIF_SAS_STP_TASK_REQUEST
79 {
80    /**
81     * This field contains the translation information utilized by SATI.
82     * For more information on this field please refer to
83     * SATI_TRANSLATOR_SEQUENCE.
84     */
85    SATI_TRANSLATOR_SEQUENCE_T  sequence;
86 
87 } SCIF_SAS_STP_TASK_REQUEST_T;
88 
89 //extern SCI_BASE_REQUEST_STATE_HANDLER_T stp_io_request_constructed_handlers;
90 
91 struct SCIF_SAS_TASK_REQUEST;
92 SCI_STATUS scif_sas_stp_task_request_construct(
93    struct SCIF_SAS_TASK_REQUEST * fw_task
94 );
95 
96 void scif_sas_stp_task_request_abort_task_set_failure_handler(
97    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
98    struct SCIF_SAS_TASK_REQUEST  * fw_task
99 );
100 
101 #ifdef __cplusplus
102 }
103 #endif // __cplusplus
104 
105 #endif // _SCIF_SAS_STP_TASK_REQUEST_H_
106 
107