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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
54 #ifndef _SCIF_SAS_IO_REQUEST_H_
55 #define _SCIF_SAS_IO_REQUEST_H_
60 * @brief This file contains the protected interface structures, constants,
61 * and methods for the SCIF_SAS_IO_REQUEST object.
68 #include <dev/isci/scil/scif_io_request.h>
69 #include <dev/isci/scil/sci_base_request.h>
70 #include <dev/isci/scil/scif_sas_request.h>
71 #include <dev/isci/scil/scif_sas_stp_io_request.h>
72 #include <dev/isci/scil/intel_sas.h>
75 struct SCIF_SAS_CONTROLLER;
76 struct SCIF_SAS_REMOTE_DEVICE;
78 //Note 0xFF is the maximum possible value to IO_RETRY_LIMIT since the io_retry_count in
79 //SCIF_SAS_IO_REQUEST is in type of U8.
80 #define SCIF_SAS_IO_RETRY_LIMIT 0xFF
83 * @struct SCIF_SAS_IO_REQUEST
85 * @brief The SCI SAS Framework IO request object abstracts the SAS IO
86 * level behavior for the framework component. Additionally,
87 * it provides a higher level of abstraction for the core IO request
90 typedef struct SCIF_SAS_IO_REQUEST
93 * The SCI_BASE_REQUEST is the parent object for the
94 * SCIF_SAS_IO_REQUEST object.
96 SCIF_SAS_REQUEST_T parent;
99 * This field specifies the number of bytes to be utilized for this
100 * IO request. This field is utilized during internal IO requests.
105 * This field keeps track of how many times an io got retried.
109 } SCIF_SAS_IO_REQUEST_T;
111 extern SCI_BASE_STATE_T scif_sas_io_request_state_table[];
112 extern SCI_BASE_REQUEST_STATE_HANDLER_T
113 scif_sas_io_request_state_handler_table[];
115 SCI_STATUS scif_sas_io_request_constructed_start_handler(
116 SCI_BASE_REQUEST_T * io_request
119 SCI_STATUS scif_sas_io_request_constructed_abort_handler(
120 SCI_BASE_REQUEST_T * io_request
123 SCI_STATUS scif_sas_io_request_default_complete_handler(
124 SCI_BASE_REQUEST_T * io_request
127 SCI_STATUS scif_sas_io_request_default_destruct_handler(
128 SCI_BASE_REQUEST_T * io_request
131 SCI_STATUS scif_sas_io_request_construct_smp(
132 struct SCIF_SAS_CONTROLLER * fw_controller,
133 struct SCIF_SAS_REMOTE_DEVICE * fw_device,
135 void * core_io_memory,
137 SMP_REQUEST_T * smp_command,
138 void * user_request_object
141 SCI_STATUS scif_sas_io_request_continue(
142 struct SCIF_SAS_CONTROLLER * fw_controller,
143 struct SCIF_SAS_REMOTE_DEVICE * fw_device,
144 SCIF_SAS_REQUEST_T * fw_request
149 #endif // __cplusplus
151 #endif // _SCIF_SAS_IO_REQUEST_H_