sci_library.h revision 330897
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: stable/11/sys/dev/isci/scil/sci_library.h 330897 2018-03-14 03:19:51Z eadler $ 55 */ 56#ifndef _SCI_LIBRARY_H_ 57#define _SCI_LIBRARY_H_ 58 59/** 60 * @file 61 * 62 * @brief This file contains all of the interface methods that can be called 63 * by an SCI user on a library object. The library is the container 64 * of all other objects being managed (i.e. controllers, target devices, 65 * sas ports, etc.). 66 */ 67 68#ifdef __cplusplus 69extern "C" { 70#endif // __cplusplus 71 72#include <dev/isci/scil/sci_types.h> 73 74 75/** 76 * @brief This method will return the major revision level for the entire 77 * SCI library. 78 * @note Format: Major.Minor.Build. 79 * 80 * @return Return an integer value indicating the major revision level. 81 */ 82U32 sci_library_get_major_version( 83 void 84); 85 86/** 87 * @brief This method will return the minor revision level for the entire 88 * SCI library. 89 * @note Format: Major.Minor.Build. 90 * 91 * @return Return an integer value indicating the minor revision level. 92 */ 93U32 sci_library_get_minor_version( 94 void 95); 96 97/** 98 * @brief This method will return the build revision level for the entire 99 * SCI library. 100 * @note Format: Major.Minor.Build. 101 * 102 * @return Return an integer value indicating the build revision level. 103 */ 104U32 sci_library_get_build_version( 105 void 106); 107 108#ifdef __cplusplus 109} 110#endif // __cplusplus 111 112#endif // _SCI_LIBRARY_H_ 113 114