1f11c7f63SJim Harris /*- 2*718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3*718cf2ccSPedro F. Giffuni * 4f11c7f63SJim Harris * This file is provided under a dual BSD/GPLv2 license. When using or 5f11c7f63SJim Harris * redistributing this file, you may do so under either license. 6f11c7f63SJim Harris * 7f11c7f63SJim Harris * GPL LICENSE SUMMARY 8f11c7f63SJim Harris * 9f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10f11c7f63SJim Harris * 11f11c7f63SJim Harris * This program is free software; you can redistribute it and/or modify 12f11c7f63SJim Harris * it under the terms of version 2 of the GNU General Public License as 13f11c7f63SJim Harris * published by the Free Software Foundation. 14f11c7f63SJim Harris * 15f11c7f63SJim Harris * This program is distributed in the hope that it will be useful, but 16f11c7f63SJim Harris * WITHOUT ANY WARRANTY; without even the implied warranty of 17f11c7f63SJim Harris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18f11c7f63SJim Harris * General Public License for more details. 19f11c7f63SJim Harris * 20f11c7f63SJim Harris * You should have received a copy of the GNU General Public License 21f11c7f63SJim Harris * along with this program; if not, write to the Free Software 22f11c7f63SJim Harris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23f11c7f63SJim Harris * The full GNU General Public License is included in this distribution 24f11c7f63SJim Harris * in the file called LICENSE.GPL. 25f11c7f63SJim Harris * 26f11c7f63SJim Harris * BSD LICENSE 27f11c7f63SJim Harris * 28f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29f11c7f63SJim Harris * All rights reserved. 30f11c7f63SJim Harris * 31f11c7f63SJim Harris * Redistribution and use in source and binary forms, with or without 32f11c7f63SJim Harris * modification, are permitted provided that the following conditions 33f11c7f63SJim Harris * are met: 34f11c7f63SJim Harris * 35f11c7f63SJim Harris * * Redistributions of source code must retain the above copyright 36f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer. 37f11c7f63SJim Harris * * Redistributions in binary form must reproduce the above copyright 38f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer in 39f11c7f63SJim Harris * the documentation and/or other materials provided with the 40f11c7f63SJim Harris * distribution. 41f11c7f63SJim Harris * 42f11c7f63SJim Harris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43f11c7f63SJim Harris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44f11c7f63SJim Harris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45f11c7f63SJim Harris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46f11c7f63SJim Harris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47f11c7f63SJim Harris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48f11c7f63SJim Harris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49f11c7f63SJim Harris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50f11c7f63SJim Harris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51f11c7f63SJim Harris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52f11c7f63SJim Harris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53f11c7f63SJim Harris */ 54f11c7f63SJim Harris #ifndef _SCIC_OVERVIEW_H_ 55f11c7f63SJim Harris #define _SCIC_OVERVIEW_H_ 56f11c7f63SJim Harris 57f11c7f63SJim Harris /** 58f11c7f63SJim Harris 59f11c7f63SJim Harris @page core_section SCI Core 60f11c7f63SJim Harris 61f11c7f63SJim Harris @section scic_introduction_section Introduction 62f11c7f63SJim Harris 63f11c7f63SJim Harris The Storage Controller Interface Core (SCIC) provides the underlying fundamental 64f11c7f63SJim Harris hardware abstractions required to implement a standard SAS/SATA storage driver. 65f11c7f63SJim Harris 66f11c7f63SJim Harris The following is a list of features that may be found in a core implementation: 67f11c7f63SJim Harris -# hardware interrupt handling 68f11c7f63SJim Harris -# hardware event handling 69f11c7f63SJim Harris -# hardware state machine handling 70f11c7f63SJim Harris -# IO and task management state machine handling 71f11c7f63SJim Harris -# Phy staggered spin up 72f11c7f63SJim Harris 73f11c7f63SJim Harris @image latex sci_core.eps "SCI Core Class Diagram" width=16cm 74f11c7f63SJim Harris 75f11c7f63SJim Harris @note 76f11c7f63SJim Harris For the SCU Driver Standard implementation of the SCI Core interface the 77f11c7f63SJim Harris following definitions should be used to augment the cardinalities described 78f11c7f63SJim Harris in the previous diagram: 79f11c7f63SJim Harris -# There are exactly 4 scic_phy objects in the scic_controller. 80f11c7f63SJim Harris -# There are exactly 4 scic_port objects in the scic_controller. 81f11c7f63SJim Harris -# There can be a maximum of 4 scic_phy objects managed in a single scic_port. 82f11c7f63SJim Harris -# The maximum number of supported controllers in a library is a truly flexible 83f11c7f63SJim Harris value, but the likely maximum number is 4. 84f11c7f63SJim Harris 85f11c7f63SJim Harris */ 86f11c7f63SJim Harris 87f11c7f63SJim Harris #endif // _SCIC_OVERVIEW_H_ 88f11c7f63SJim Harris 89