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_INTERNAL_REQUEST_H_
55#define _SCIF_SAS_INTERNAL_REQUEST_H_
56
57/**
58 * @file
59 *
60 * @brief This file contains the protected interface structures, constants,
61 *        and methods for the SCIF_SAS_INTERNAL_REQUEST object.
62 */
63
64#ifdef __cplusplus
65extern "C" {
66#endif // __cplusplus
67
68
69#include <dev/isci/scil/scif_io_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_io_request.h>
73#include <dev/isci/scil/scif_sas_remote_device.h>
74#include <dev/isci/scil/intel_sas.h>
75#include <dev/isci/scil/sci_controller_constants.h>
76
77struct SCIF_SAS_CONTROLLER;
78
79/**
80 * This constant dictates the maximum number of internal framework
81 *  IO request objects.  These objects are used for internal SMP requests
82 *  and for NCQ error handling.
83 */
84#define SCIF_SAS_MAX_INTERNAL_REQUEST_COUNT (SCI_MAX_DOMAINS*4)
85
86/**
87 * This constant dictates the minimum number of internal framework
88 *  IO request objects when size-constrained.
89 */
90#define SCIF_SAS_MIN_INTERNAL_REQUEST_COUNT (SCI_MAX_DOMAINS)
91
92/*
93 * This constant indicates the timeout value of an internal IO request
94 * in mili-seconds.
95 */
96#define SCIF_SAS_INTERNAL_REQUEST_TIMEOUT   3000
97
98/**
99 * @struct SCIF_SAS_INTERNAL_IO_REQUEST
100 *
101 * @brief The SCIF_SAS_INTERNAL_IO_REQUEST object represents the internal SAS
102 *        IO request behavior for the framework component.
103 */
104typedef struct SCIF_SAS_INTERNAL_IO_REQUEST
105{
106   /**
107    * The SCIF_SAS_IO_REQUEST is the parent object for the
108    * SCIF_SAS_INTERNAL_IO_REQUEST object.
109    */
110   SCIF_SAS_IO_REQUEST_T  parent;
111
112   /**
113    * This field will be utilized only by internal IO to handle timeout
114    * situation.
115    */
116   void * internal_io_timer;
117
118}SCIF_SAS_INTERNAL_IO_REQUEST_T;
119
120
121U32 scif_sas_internal_request_get_object_size(
122   void
123);
124
125SCI_STATUS scif_sas_internal_io_request_construct_smp(
126   struct SCIF_SAS_CONTROLLER  * fw_controller,
127   SCIF_SAS_REMOTE_DEVICE_T    * fw_remote_device,
128   void                        * internal_io_memory,
129   U16                           io_tag,
130   SMP_REQUEST_T               * smp_command
131);
132
133SCI_STATUS scif_sas_internal_io_request_construct_stp(
134   SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io
135);
136
137void scif_sas_internal_io_request_timeout_handler(
138   void * fw_io
139);
140
141void scif_sas_internal_io_request_complete(
142   struct SCIF_SAS_CONTROLLER     * fw_controller,
143   SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io,
144   SCI_STATUS                       completion_status
145);
146
147void scif_sas_internal_io_request_destruct(
148   struct SCIF_SAS_CONTROLLER     * fw_controller,
149   SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io
150);
151
152#ifdef __cplusplus
153}
154#endif // __cplusplus
155
156#endif // _SCIF_SAS_IO_REQUEST_H_
157
158