isci: Intel(R) C600 Series Chipset Storage Control Unit Driver
[platform/adaptation/renesas_rcar/renesas_kernel.git] / drivers / scsi / isci / core / sci_controller_constants.h
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  *   * Neither the name of Intel Corporation nor the names of its
40  *     contributors may be used to endorse or promote products derived
41  *     from this software without specific prior written permission.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54  */
55
56 #ifndef _SCI_CONTROLLER_CONSTANTS_H_
57 #define _SCI_CONTROLLER_CONSTANTS_H_
58
59 /**
60  * This file contains constant values that change based on the type of core or
61  *    framework being managed.  These constants are exported in order to
62  *    provide the user with information as to the bounds (i.e. how many) of
63  *    specific objects.
64  *
65  *
66  */
67
68
69 #ifdef SCIC_SDS_4_ENABLED
70
71 #ifndef SCI_MAX_PHYS
72 /**
73  *
74  *
75  * This constant defines the maximum number of phy objects that can be
76  * supported for the SCU Driver Standard (SDS) library.  This is tied directly
77  * to silicon capabilities.
78  */
79 #define SCI_MAX_PHYS  (4)
80 #endif
81
82 #ifndef SCI_MAX_PORTS
83 /**
84  *
85  *
86  * This constant defines the maximum number of port objects that can be
87  * supported for the SCU Driver Standard (SDS) library.  This is tied directly
88  * to silicon capabilities.
89  */
90 #define SCI_MAX_PORTS SCI_MAX_PHYS
91 #endif
92
93 #ifndef SCI_MIN_SMP_PHYS
94 /**
95  *
96  *
97  * This constant defines the minimum number of SMP phy objects that can be
98  * supported for a single expander level. This was determined by using 36
99  * physical phys and room for 2 virtual phys.
100  */
101 #define SCI_MIN_SMP_PHYS  (38)
102 #endif
103
104 #ifndef SCI_MAX_SMP_PHYS
105 /**
106  *
107  *
108  * This constant defines the maximum number of SMP phy objects that can be
109  * supported for the SCU Driver Standard (SDS) library. This number can be
110  * increased if required.
111  */
112 #define SCI_MAX_SMP_PHYS  (384)
113 #endif
114
115 #ifndef SCI_MAX_REMOTE_DEVICES
116 /**
117  *
118  *
119  * This constant defines the maximum number of remote device objects that can
120  * be supported for the SCU Driver Standard (SDS) library.  This is tied
121  * directly to silicon capabilities.
122  */
123 #define SCI_MAX_REMOTE_DEVICES (256)
124 #endif
125
126 #ifndef SCI_MIN_REMOTE_DEVICES
127 /**
128  *
129  *
130  * This constant defines the minimum number of remote device objects that can
131  * be supported for the SCU Driver Standard (SDS) library.  This # can be
132  * configured for minimum memory environments to any value less than
133  * SCI_MAX_REMOTE_DEVICES
134  */
135 #define SCI_MIN_REMOTE_DEVICES (16)
136 #endif
137
138 #ifndef SCI_MAX_IO_REQUESTS
139 /**
140  *
141  *
142  * This constant defines the maximum number of IO request objects that can be
143  * supported for the SCU Driver Standard (SDS) library.  This is tied directly
144  * to silicon capabilities.
145  */
146 #define SCI_MAX_IO_REQUESTS (256)
147 #endif
148
149 #ifndef SCI_MIN_IO_REQUESTS
150 /**
151  *
152  *
153  * This constant defines the minimum number of IO request objects that can be
154  * supported for the SCU Driver Standard (SDS) library.  This # can be
155  * configured for minimum memory environments to any value less than
156  * SCI_MAX_IO_REQUESTS.
157  */
158 #define SCI_MIN_IO_REQUESTS (1)
159 #endif
160
161 #ifndef SCI_MAX_MSIX_MESSAGES
162 /**
163  *
164  *
165  * This constant defines the maximum number of MSI-X interrupt vectors/messages
166  * supported for an SCU hardware controller instance.
167  */
168 #define SCI_MAX_MSIX_MESSAGES  (2)
169 #endif
170
171 #ifndef SCI_MAX_SCATTER_GATHER_ELEMENTS
172 /**
173  *
174  *
175  * This constant defines the maximum number of Scatter-Gather Elements to be
176  * used by any SCI component.
177  */
178 #define SCI_MAX_SCATTER_GATHER_ELEMENTS 130
179 #endif
180
181 #ifndef SCI_MIN_SCATTER_GATHER_ELEMENTS
182 /**
183  *
184  *
185  * This constant defines the minimum number of Scatter-Gather Elements to be
186  * used by any SCI component.
187  */
188 #define SCI_MIN_SCATTER_GATHER_ELEMENTS 1
189 #endif
190
191 #else /* SCIC_SDS_4_ENABLED */
192
193 #error "SCI Core configuration left unspecified (e.g. SCIC_SDS_4_ENABLED)"
194
195 #endif /* SCIC_SDS_4_ENABLED */
196
197 /**
198  *
199  *
200  * This constant defines the maximum number of controllers that can occur in a
201  * single silicon package.
202  */
203 #define SCI_MAX_CONTROLLERS 2
204
205 /**
206  *
207  *
208  * The maximum number of supported domain objects is currently tied to the
209  * maximum number of support port objects.
210  */
211 #define SCI_MAX_DOMAINS  SCI_MAX_PORTS
212
213
214 #endif  /* _SCI_CONTROLLER_CONSTANTS_H_ */
215