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_OVERVIEW_H_
57 #define _SCIF_OVERVIEW_H_
60 @page framework_page SCI Framework
62 @section scif_introduction_section Introduction
64 The SCI Framework component provides SAS and SATA storage specific abstraction
65 to any OS driver devoid of this type of functionality. The functionality
66 provided by this component is of a higher nature and considered unnecessary
67 for some driver environments. Basically, a user should be able to utilize
68 the same SCI Framework with different SCI Core implementations, with the
69 little to no changes necessary.
71 @warning In situations where the SCI framework is utilized, users should NOT
72 invoke core methods on core objects for which there are associated
73 framework objects and framework methods. Therefore, if a method is
74 common to both the core and the framework object, do not invoke the
75 core method if utilizing the framework. Some exceptions to this
76 exist and are called out. It is important to mention that methods
77 found only in the core are safe to invoke at times specified per
78 that methods definition.
80 The following is a list of features found in an SCI Framework implementation:
82 -# SCI Core management
83 -# Port configuration scheme enforcement. There are 2 port configuration
85 -# Automatic Port Configuration (APC). In APC mode the framework will
86 allow for any port configuration based on what is physically connected,
87 assuming the underlying SCI Core also supports the configuration.
88 -# Manual Port Configuration (MPC). In MPC mode the framework expects the
89 user to supply exactly which phys are to be allocated to each specific
90 port. If the discovered direct attached physical connections do not match
91 the user supplied map, then an error is raised and the initialization
94 -# Domain level resets (i.e. bus reset)
95 -# Task management processing
96 -# Controller Shutdown management (e.g. release STP affiliations, quiesce IOs)
97 -# Remote Device Configuration. Potential features:
98 -# SSP: maybe mode selects to set timers or modify DIF settings.
99 -# STP: IDENTIFY_DEVICE, SET FEATURES, etc.
100 -# SMP: CONTROL type requests to set timers.
101 -# SAT Translation (Actually contained in SATI component)
102 -# SMP Zoning management
104 @image latex sci_framework.eps "SCI Framework Class Diagram" width=10cm
107 For the SCU Driver Standard implementation of the SCI Framework interface the
108 following definitions should be used to augment the cardinalities described
109 in the previous diagram:
110 -# There are exactly 4 scif_domain objects in the scif_controller. This
111 number directly correlates to the number of scic_port objects in the core.
112 -# The maximum number of supported controllers in a library is a truly flexible
113 value, but the likely maximum number is 4.
117 #endif // _SCIF_OVERVIEW_H_