1/*-
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.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
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.
12 *
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.
17 *
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.
23 *
24 * BSD LICENSE
25 *
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
28 *
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
32 *
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
38 *     distribution.
39 *
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.
51 *
52 * $FreeBSD$
53 */
54#ifndef _SCI_OBJECT_H_
55#define _SCI_OBJECT_H_
56
57/**
58 * @file
59 *
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.
63 */
64
65#ifdef __cplusplus
66extern "C" {
67#endif // __cplusplus
68
69#include <dev/isci/scil/sci_types.h>
70#include <dev/isci/scil/sci_status.h>
71
72/**
73 * @brief This method returns the object to which a previous association was
74 *        created.  This association represents a link between an SCI object
75 *        and another SCI object or potentially a user object.  The
76 *        association essentially acts as a cookie for the user of an object.
77 *        The user of an SCI object is now able to retrieve a handle to their
78 *        own object that is managing, or related in someway, to said SCI
79 *        object.
80 *
81 * @param[in]  base_object This parameter specifies the SCI object for
82 *             which to retrieve the association reference.
83 *
84 * @return This method returns a pointer to the object that was previously
85 *         associated to the supplied base_object parameter.
86 * @retval SCI_INVALID_HANDLE This value is returned when there is no known
87 *         association for the supplied base_object instance.
88 */
89#if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS)
90void * sci_object_get_association(
91   SCI_OBJECT_HANDLE_T  base_object
92);
93#else
94#define sci_object_get_association(object) (*((void **)object))
95#endif
96
97/**
98 * @brief This method will associate to SCI objects.
99 *
100 * @see   For more information about associations please reference the
101 *        sci_object_get_association() method.
102 *
103 * @param[in]  base_object This parameter specifies the SCI object for
104 *             which to set the association reference.
105 * @param[in]  associated_object This parameter specifies a pointer to the
106 *             object being associated.
107 *
108 * @return This method will return an indication as to whether the
109 *         association was set successfully.
110 * @retval SCI_SUCCESS This value is currently always returned.
111 */
112#if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS)
113SCI_STATUS sci_object_set_association(
114   SCI_OBJECT_HANDLE_T   base_object,
115   void                * associated_object
116);
117#else
118#define sci_object_set_association(base_object, associated_object) \
119   ((*((void **)base_object)) = (associated_object))
120#endif
121
122/**
123 * @brief This method will get the logger for an object.
124 *
125 * @param[in] object This parameter specifies SCI object for
126 *       which to retrieve its logger.
127 *
128 * @return This method returns a SCI_LOGGER_HANDLE to SCI user.
129 */
130SCI_LOGGER_HANDLE_T sci_object_get_logger(
131   SCI_OBJECT_HANDLE_T object
132);
133
134#ifdef __cplusplus
135}
136#endif // __cplusplus
137
138#endif // _SCI_OBJECT_H_
139
140