sys/dev/isci/scil/scic_sds_library.h

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