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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
54 #ifndef _SCI_BASE_OBJECT_H_
55 #define _SCI_BASE_OBJECT_H_
60 * @brief This file contains all of the method and constants associated with
61 * the SCI base object. The SCI base object is the class from which
62 * all other objects derive in the Storage Controller Interface.
69 #include <dev/isci/scil/sci_object.h>
71 // Forward declare the logger object
72 struct SCI_BASE_LOGGER;
75 * @struct SCI_BASE_OBJECT
77 * @brief The SCI_BASE_OBJECT object represents the data and functionality
78 * that is common to all SCI objects. It is the base class.
80 typedef struct SCI_BASE_OBJECT
83 * This field represents an association created by the user for this
84 * object. The association can be whatever the user wishes. Think of
87 void * associated_object;
90 * This field simply contains a handle to the logger object to be
91 * utilized when utilizing the logger interface.
93 struct SCI_BASE_LOGGER * logger;
99 * @brief This method constructs the sci base object.
101 * @param[in] base_object This parameter specifies the SCI base
102 * object which we whish to construct.
103 * @param[in] logger This parameter specifies the logger object to be
104 * saved and utilized for this base object.
108 void sci_base_object_construct(
109 SCI_BASE_OBJECT_T * base_object,
110 struct SCI_BASE_LOGGER * logger
113 #if defined(SCI_LOGGING)
115 * @brief This method returns the logger to which a previous
116 * association was created.
118 * @param[in] base_object This parameter specifies the SCI base object for
119 * which to retrieve the logger.
121 * @return This method returns a pointer to the logger that was
122 * previously associated to the supplied base_object
124 * @retval NULL This value is returned when there is no logger
125 * association for the supplied base_object instance.
127 #define sci_base_object_get_logger(this_object) \
128 (((SCI_BASE_OBJECT_T *)(this_object))->logger)
130 #else // defined(SCI_LOGGING)
132 #define sci_base_object_get_logger(this_object) NULL
134 #endif // defined(SCI_LOGGING)
138 #endif // __cplusplus
141 #endif // _SCI_BASE_OBJECT_H_