sci_library.h revision 230843
1227064Sbz/*-
2250340Sdavidcs * This file is provided under a dual BSD/GPLv2 license.  When using or
3227064Sbz * redistributing this file, you may do so under either license.
4227064Sbz *
5227064Sbz * GPL LICENSE SUMMARY
6227064Sbz *
7227064Sbz * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8227064Sbz *
9227064Sbz * This program is free software; you can redistribute it and/or modify
10227064Sbz * it under the terms of version 2 of the GNU General Public License as
11227064Sbz * published by the Free Software Foundation.
12227064Sbz *
13227064Sbz * This program is distributed in the hope that it will be useful, but
14227064Sbz * WITHOUT ANY WARRANTY; without even the implied warranty of
15227064Sbz * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16227064Sbz * General Public License for more details.
17227064Sbz *
18227064Sbz * You should have received a copy of the GNU General Public License
19227064Sbz * along with this program; if not, write to the Free Software
20227064Sbz * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21227064Sbz * The full GNU General Public License is included in this distribution
22227064Sbz * in the file called LICENSE.GPL.
23227064Sbz *
24227064Sbz * BSD LICENSE
25227064Sbz *
26227064Sbz * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27227064Sbz * All rights reserved.
28227064Sbz *
29227064Sbz * Redistribution and use in source and binary forms, with or without
30227064Sbz * modification, are permitted provided that the following conditions
31227064Sbz * are met:
32227064Sbz *
33227064Sbz *   * Redistributions of source code must retain the above copyright
34227064Sbz *     notice, this list of conditions and the following disclaimer.
35227064Sbz *   * Redistributions in binary form must reproduce the above copyright
36227064Sbz *     notice, this list of conditions and the following disclaimer in
37227064Sbz *     the documentation and/or other materials provided with the
38227064Sbz *     distribution.
39227064Sbz *
40227064Sbz * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41227064Sbz * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42227064Sbz * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43227064Sbz * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44227064Sbz * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45227064Sbz * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46227064Sbz * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47227064Sbz * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48227064Sbz * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49227064Sbz * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50227064Sbz * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51227064Sbz *
52227064Sbz * $FreeBSD$
53227064Sbz */
54227064Sbz#ifndef _SCI_LIBRARY_H_
55227064Sbz#define _SCI_LIBRARY_H_
56227064Sbz
57227064Sbz/**
58227064Sbz * @file
59227064Sbz *
60227064Sbz * @brief This file contains all of the interface methods that can be called
61227064Sbz *        by an SCI user on a library object.  The library is the container
62227064Sbz *        of all other objects being managed (i.e. controllers, target devices,
63227064Sbz *        sas ports, etc.).
64227064Sbz */
65227064Sbz
66227064Sbz#ifdef __cplusplus
67227064Sbzextern "C" {
68227064Sbz#endif // __cplusplus
69227064Sbz
70227064Sbz#include <dev/isci/scil/sci_types.h>
71227064Sbz
72227064Sbz
73227064Sbz/**
74227064Sbz * @brief This method will return the major revision level for the entire
75227064Sbz *        SCI library.
76227064Sbz * @note  Format: Major.Minor.Build.
77227064Sbz *
78227064Sbz * @return Return an integer value indicating the major revision level.
79227064Sbz */
80227064SbzU32 sci_library_get_major_version(
81227064Sbz   void
82227064Sbz);
83227064Sbz
84227064Sbz/**
85227064Sbz * @brief This method will return the minor revision level for the entire
86227064Sbz *        SCI library.
87227064Sbz * @note  Format: Major.Minor.Build.
88227064Sbz *
89227064Sbz * @return Return an integer value indicating the minor revision level.
90227064Sbz */
91227064SbzU32 sci_library_get_minor_version(
92227064Sbz   void
93227064Sbz);
94227064Sbz
95227064Sbz/**
96227064Sbz * @brief This method will return the build revision level for the entire
97227064Sbz *        SCI library.
98227064Sbz * @note  Format: Major.Minor.Build.
99227064Sbz *
100227064Sbz * @return Return an integer value indicating the build revision level.
101227064Sbz */
102227064SbzU32 sci_library_get_build_version(
103227064Sbz   void
104227064Sbz);
105227064Sbz
106227064Sbz#ifdef __cplusplus
107227064Sbz}
108227064Sbz#endif // __cplusplus
109227064Sbz
110227064Sbz#endif // _SCI_LIBRARY_H_
111227064Sbz
112227064Sbz