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_INTERNAL_REQUEST_H_
57 #define _SCIF_SAS_INTERNAL_REQUEST_H_
62 * @brief This file contains the protected interface structures, constants,
63 * and methods for the SCIF_SAS_INTERNAL_REQUEST object.
71 #include <dev/isci/scil/scif_io_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_io_request.h>
75 #include <dev/isci/scil/scif_sas_remote_device.h>
76 #include <dev/isci/scil/intel_sas.h>
77 #include <dev/isci/scil/sci_controller_constants.h>
79 struct SCIF_SAS_CONTROLLER;
82 * This constant dictates the maximum number of internal framework
83 * IO request objects. These objects are used for internal SMP requests
84 * and for NCQ error handling.
86 #define SCIF_SAS_MAX_INTERNAL_REQUEST_COUNT (SCI_MAX_DOMAINS*4)
89 * This constant dictates the minimum number of internal framework
90 * IO request objects when size-constrained.
92 #define SCIF_SAS_MIN_INTERNAL_REQUEST_COUNT (SCI_MAX_DOMAINS)
95 * This constant indicates the timeout value of an internal IO request
98 #define SCIF_SAS_INTERNAL_REQUEST_TIMEOUT 3000
101 * @struct SCIF_SAS_INTERNAL_IO_REQUEST
103 * @brief The SCIF_SAS_INTERNAL_IO_REQUEST object represents the internal SAS
104 * IO request behavior for the framework component.
106 typedef struct SCIF_SAS_INTERNAL_IO_REQUEST
109 * The SCIF_SAS_IO_REQUEST is the parent object for the
110 * SCIF_SAS_INTERNAL_IO_REQUEST object.
112 SCIF_SAS_IO_REQUEST_T parent;
115 * This field will be utilized only by internal IO to handle timeout
118 void * internal_io_timer;
120 }SCIF_SAS_INTERNAL_IO_REQUEST_T;
123 U32 scif_sas_internal_request_get_object_size(
127 SCI_STATUS scif_sas_internal_io_request_construct_smp(
128 struct SCIF_SAS_CONTROLLER * fw_controller,
129 SCIF_SAS_REMOTE_DEVICE_T * fw_remote_device,
130 void * internal_io_memory,
132 SMP_REQUEST_T * smp_command
135 SCI_STATUS scif_sas_internal_io_request_construct_stp(
136 SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io
139 void scif_sas_internal_io_request_timeout_handler(
143 void scif_sas_internal_io_request_complete(
144 struct SCIF_SAS_CONTROLLER * fw_controller,
145 SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io,
146 SCI_STATUS completion_status
149 void scif_sas_internal_io_request_destruct(
150 struct SCIF_SAS_CONTROLLER * fw_controller,
151 SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io
156 #endif // __cplusplus
158 #endif // _SCIF_SAS_IO_REQUEST_H_