1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 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. 6 * 7 * GPL LICENSE SUMMARY 8 * 9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10 * 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. 14 * 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. 19 * 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. 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 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 40 * distribution. 41 * 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. 53 */ 54 #ifndef _SCIF_OVERVIEW_H_ 55 #define _SCIF_OVERVIEW_H_ 56 57 /** 58 @page framework_page SCI Framework 59 60 @section scif_introduction_section Introduction 61 62 The SCI Framework component provides SAS and SATA storage specific abstraction 63 to any OS driver devoid of this type of functionality. The functionality 64 provided by this component is of a higher nature and considered unnecessary 65 for some driver environments. Basically, a user should be able to utilize 66 the same SCI Framework with different SCI Core implementations, with the 67 little to no changes necessary. 68 69 @warning In situations where the SCI framework is utilized, users should NOT 70 invoke core methods on core objects for which there are associated 71 framework objects and framework methods. Therefore, if a method is 72 common to both the core and the framework object, do not invoke the 73 core method if utilizing the framework. Some exceptions to this 74 exist and are called out. It is important to mention that methods 75 found only in the core are safe to invoke at times specified per 76 that methods definition. 77 78 The following is a list of features found in an SCI Framework implementation: 79 80 -# SCI Core management 81 -# Port configuration scheme enforcement. There are 2 port configuration 82 schemes: 83 -# Automatic Port Configuration (APC). In APC mode the framework will 84 allow for any port configuration based on what is physically connected, 85 assuming the underlying SCI Core also supports the configuration. 86 -# Manual Port Configuration (MPC). In MPC mode the framework expects the 87 user to supply exactly which phys are to be allocated to each specific 88 port. If the discovered direct attached physical connections do not match 89 the user supplied map, then an error is raised and the initialization 90 process is halted. 91 -# Domain Discovery 92 -# Domain level resets (i.e. bus reset) 93 -# Task management processing 94 -# Controller Shutdown management (e.g. release STP affiliations, quiesce IOs) 95 -# Remote Device Configuration. Potential features: 96 -# SSP: maybe mode selects to set timers or modify DIF settings. 97 -# STP: IDENTIFY_DEVICE, SET FEATURES, etc. 98 -# SMP: CONTROL type requests to set timers. 99 -# SAT Translation (Actually contained in SATI component) 100 -# SMP Zoning management 101 102 @image latex sci_framework.eps "SCI Framework Class Diagram" width=10cm 103 104 @note 105 For the SCU Driver Standard implementation of the SCI Framework interface the 106 following definitions should be used to augment the cardinalities described 107 in the previous diagram: 108 -# There are exactly 4 scif_domain objects in the scif_controller. This 109 number directly correlates to the number of scic_port objects in the core. 110 -# The maximum number of supported controllers in a library is a truly flexible 111 value, but the likely maximum number is 4. 112 113 */ 114 115 #endif // _SCIF_OVERVIEW_H_ 116 117