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 _SCIC_SDS_LIBRARY_H_ 55 #define _SCIC_SDS_LIBRARY_H_ 56 57 /** 58 * @file 59 * 60 * @brief This file contains the structures used by the core library object. 61 * All of the functionality for the core library is in the 62 * sci_base_library.h file. 63 */ 64 65 #ifdef __cplusplus 66 extern "C" { 67 #endif // __cplusplus 68 69 #include <dev/isci/scil/sci_base_library.h> 70 #include <dev/isci/scil/scic_sds_pci.h> 71 72 // Forward declar the controllers 73 struct SCIC_SDS_CONTROLLER; 74 75 /** 76 * @struct SCIC_SDS_LIBRARY 77 * 78 * This structure contains data used by the core library. 79 */ 80 typedef struct SCIC_SDS_LIBRARY 81 { 82 /* 83 * The SCI_BASE_LIBRARY is the parent object for the SCIC_SDS_LIBRARY 84 * object. 85 */ 86 SCI_BASE_LIBRARY_T parent; 87 88 /** 89 * This is the count of the maximum number of controllers that this library 90 * can contain. 91 */ 92 U32 max_controller_count; 93 94 /** 95 * The PCI header for this library object all libraries must have the same 96 * pci device id. 97 */ 98 U16 pci_device; 99 U8 pci_revision; 100 101 /** 102 * This field is the array of controllers that are contained within the 103 * library object. 104 */ 105 struct SCIC_SDS_CONTROLLER *controllers; 106 107 } SCIC_SDS_LIBRARY_T; 108 109 U8 scic_sds_library_get_controller_index( 110 struct SCIC_SDS_LIBRARY * library, 111 struct SCIC_SDS_CONTROLLER * controller 112 ); 113 114 #ifdef __cplusplus 115 } 116 #endif // __cplusplus 117 118 #endif // _SCIC_SDS_LIBRARY_H_ 119