scif_sas_task_request.h revision 330897 
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 * $FreeBSD: stable/11/sys/dev/isci/scil/scif_sas_task_request.h 330897 2018-03-14 03:19:51Z eadler $
55 */
56#ifndef _SCIF_SAS_TASK_REQUEST_H_
57#define _SCIF_SAS_TASK_REQUEST_H_
58
59/**
60 * @file
61 *
62 * @brief This file contains the protected interface structures, constants,
63 *        and methods for the SCIF_SAS_TASK_REQUEST object.
64 */
65
66#ifdef __cplusplus
67extern "C" {
68#endif // __cplusplus
69
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>
76
77/**
78 * @struct SCIF_SAS_TASK_REQUEST
79 *
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
83 *        request object.
84 */
85typedef struct SCIF_SAS_TASK_REQUEST
86{
87   /**
88    * The SCIF_SAS_REQUEST is the parent object for the
89    * SCIF_SAS_TASK_REQUEST object.
90    */
91   SCIF_SAS_REQUEST_T  parent;
92
93   /**
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).
97    */
98   U16  affected_request_count;
99
100   /**
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.
104    */
105   U16  io_tag_to_manage;
106
107   /**
108    * This field will be utilized to specify the task management function
109    * of this task request.
110    */
111   SCI_SAS_TASK_MGMT_FUNCTION_T function;
112
113} SCIF_SAS_TASK_REQUEST_T;
114
115extern SCI_BASE_STATE_T scif_sas_task_request_state_table[];
116extern SCI_BASE_REQUEST_STATE_HANDLER_T
117   scif_sas_task_request_state_handler_table[];
118
119void scif_sas_task_request_operation_complete(
120   SCIF_SAS_TASK_REQUEST_T * fw_task
121);
122
123U8 scif_sas_task_request_get_function(
124   SCIF_SAS_TASK_REQUEST_T * fw_task
125);
126
127SCI_STATUS scif_sas_internal_task_request_construct(
128   SCI_CONTROLLER_HANDLE_T      scif_controller,
129   SCI_REMOTE_DEVICE_HANDLE_T   scif_remote_device,
130   U16                          io_tag,
131   void                       * task_request_memory,
132   SCI_TASK_REQUEST_HANDLE_T  * scif_task_request,
133   U8                           task_function
134);
135
136void scif_sas_internal_task_request_destruct(
137   SCIF_SAS_TASK_REQUEST_T * fw_internal_task
138);
139
140#ifdef __cplusplus
141}
142#endif // __cplusplus
143
144#endif // _SCIF_SAS_TASK_REQUEST_H_
145
146