1/*-
2 * This file is provided under a dual BSD/GPLv2 license.  When using or
3 * redistributing this file, you may do so under either license.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
23 *
24 * BSD LICENSE
25 *
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
28 *
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
32 *
33 *   * Redistributions of source code must retain the above copyright
34 *     notice, this list of conditions and the following disclaimer.
35 *   * Redistributions in binary form must reproduce the above copyright
36 *     notice, this list of conditions and the following disclaimer in
37 *     the documentation and/or other materials provided with the
38 *     distribution.
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 *
52 * $FreeBSD$
53 */
54#ifndef _SCIF_SAS_TASK_REQUEST_H_
55#define _SCIF_SAS_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_TASK_REQUEST object.
62 */
63
64#ifdef __cplusplus
65extern "C" {
66#endif // __cplusplus
67
68#include <dev/isci/scil/sati_translator_sequence.h>
69#include <dev/isci/scil/scif_task_request.h>
70#include <dev/isci/scil/sci_base_request.h>
71#include <dev/isci/scil/scif_sas_request.h>
72#include <dev/isci/scil/scif_sas_internal_io_request.h>
73#include <dev/isci/scil/intel_sas.h>
74
75/**
76 * @struct SCIF_SAS_TASK_REQUEST
77 *
78 * @brief The SCI SAS Framework Task request object abstracts the SAS task
79 *        management behavior for the framework component.  Additionally,
80 *        it provides a higher level of abstraction for the core task
81 *        request object.
82 */
83typedef struct SCIF_SAS_TASK_REQUEST
84{
85   /**
86    * The SCIF_SAS_REQUEST is the parent object for the
87    * SCIF_SAS_TASK_REQUEST object.
88    */
89   SCIF_SAS_REQUEST_T  parent;
90
91   /**
92    * This field contains the number of current requests affected by
93    * this task management request.  This number indicates all of the
94    * requests terminated in the silicon (including previous task requests).
95    */
96   U16  affected_request_count;
97
98   /**
99    * This field specifies the tag for the IO request or the tag to be
100    * managed for a task management request.
101    * This field is utilized during internal IO requests.
102    */
103   U16  io_tag_to_manage;
104
105   /**
106    * This field will be utilized to specify the task management function
107    * of this task request.
108    */
109   SCI_SAS_TASK_MGMT_FUNCTION_T function;
110
111} SCIF_SAS_TASK_REQUEST_T;
112
113extern SCI_BASE_STATE_T scif_sas_task_request_state_table[];
114extern SCI_BASE_REQUEST_STATE_HANDLER_T
115   scif_sas_task_request_state_handler_table[];
116
117void scif_sas_task_request_operation_complete(
118   SCIF_SAS_TASK_REQUEST_T * fw_task
119);
120
121U8 scif_sas_task_request_get_function(
122   SCIF_SAS_TASK_REQUEST_T * fw_task
123);
124
125SCI_STATUS scif_sas_internal_task_request_construct(
126   SCI_CONTROLLER_HANDLE_T      scif_controller,
127   SCI_REMOTE_DEVICE_HANDLE_T   scif_remote_device,
128   U16                          io_tag,
129   void                       * task_request_memory,
130   SCI_TASK_REQUEST_HANDLE_T  * scif_task_request,
131   U8                           task_function
132);
133
134void scif_sas_internal_task_request_destruct(
135   SCIF_SAS_TASK_REQUEST_T * fw_internal_task
136);
137
138#ifdef __cplusplus
139}
140#endif // __cplusplus
141
142#endif // _SCIF_SAS_TASK_REQUEST_H_
143
144