2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
56 #ifndef _SCI_BASE_OBJECT_H_
57 #define _SCI_BASE_OBJECT_H_
62 * @brief This file contains all of the method and constants associated with
63 * the SCI base object. The SCI base object is the class from which
64 * all other objects derive in the Storage Controller Interface.
71 #include <dev/isci/scil/sci_object.h>
73 // Forward declare the logger object
74 struct SCI_BASE_LOGGER;
77 * @struct SCI_BASE_OBJECT
79 * @brief The SCI_BASE_OBJECT object represents the data and functionality
80 * that is common to all SCI objects. It is the base class.
82 typedef struct SCI_BASE_OBJECT
85 * This field represents an association created by the user for this
86 * object. The association can be whatever the user wishes. Think of
89 void * associated_object;
92 * This field simply contains a handle to the logger object to be
93 * utilized when utilizing the logger interface.
95 struct SCI_BASE_LOGGER * logger;
101 * @brief This method constructs the sci base object.
103 * @param[in] base_object This parameter specifies the SCI base
104 * object which we whish to construct.
105 * @param[in] logger This parameter specifies the logger object to be
106 * saved and utilized for this base object.
110 void sci_base_object_construct(
111 SCI_BASE_OBJECT_T * base_object,
112 struct SCI_BASE_LOGGER * logger
115 #if defined(SCI_LOGGING)
117 * @brief This method returns the logger to which a previous
118 * association was created.
120 * @param[in] base_object This parameter specifies the SCI base object for
121 * which to retrieve the logger.
123 * @return This method returns a pointer to the logger that was
124 * previously associated to the supplied base_object
126 * @retval NULL This value is returned when there is no logger
127 * association for the supplied base_object instance.
129 #define sci_base_object_get_logger(this_object) \
130 (((SCI_BASE_OBJECT_T *)(this_object))->logger)
132 #else // defined(SCI_LOGGING)
134 #define sci_base_object_get_logger(this_object) NULL
136 #endif // defined(SCI_LOGGING)
140 #endif // __cplusplus
143 #endif // _SCI_BASE_OBJECT_H_