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_OBJECT_H_
57 #define _SCI_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_types.h>
72 #include <dev/isci/scil/sci_status.h>
75 * @brief This method returns the object to which a previous association was
76 * created. This association represents a link between an SCI object
77 * and another SCI object or potentially a user object. The
78 * association essentially acts as a cookie for the user of an object.
79 * The user of an SCI object is now able to retrieve a handle to their
80 * own object that is managing, or related in someway, to said SCI
83 * @param[in] base_object This parameter specifies the SCI object for
84 * which to retrieve the association reference.
86 * @return This method returns a pointer to the object that was previously
87 * associated to the supplied base_object parameter.
88 * @retval SCI_INVALID_HANDLE This value is returned when there is no known
89 * association for the supplied base_object instance.
91 #if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS)
92 void * sci_object_get_association(
93 SCI_OBJECT_HANDLE_T base_object
96 #define sci_object_get_association(object) (*((void **)object))
100 * @brief This method will associate to SCI objects.
102 * @see For more information about associations please reference the
103 * sci_object_get_association() method.
105 * @param[in] base_object This parameter specifies the SCI object for
106 * which to set the association reference.
107 * @param[in] associated_object This parameter specifies a pointer to the
108 * object being associated.
110 * @return This method will return an indication as to whether the
111 * association was set successfully.
112 * @retval SCI_SUCCESS This value is currently always returned.
114 #if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS)
115 SCI_STATUS sci_object_set_association(
116 SCI_OBJECT_HANDLE_T base_object,
117 void * associated_object
120 #define sci_object_set_association(base_object, associated_object) \
121 ((*((void **)base_object)) = (associated_object))
125 * @brief This method will get the logger for an object.
127 * @param[in] object This parameter specifies SCI object for
128 * which to retrieve its logger.
130 * @return This method returns a SCI_LOGGER_HANDLE to SCI user.
132 SCI_LOGGER_HANDLE_T sci_object_get_logger(
133 SCI_OBJECT_HANDLE_T object
138 #endif // __cplusplus
140 #endif // _SCI_OBJECT_H_