xref: /freebsd/sys/dev/isci/scil/sci_base_object.c (revision 685dc743dc3b5645e34836464128e1c0558b404b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3  *
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.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10  *
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.
14  *
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.
19  *
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.
25  *
26  * BSD LICENSE
27  *
28  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29  * All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  *
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
40  *     distribution.
41  *
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.
53  */
54 
55 #include <sys/cdefs.h>
56 /**
57  * @file
58  *
59  * @brief This file contains all of the method implementations for the
60  *        SCI_BASE_OBJECT object.
61  */
62 
63 #include <dev/isci/scil/sci_status.h>
64 #include <dev/isci/scil/sci_types.h>
65 #include <dev/isci/scil/sci_base_object.h>
66 
67 //******************************************************************************
68 //* P U B L I C   M E T H O D S
69 //******************************************************************************
70 
71 #if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS)
sci_object_get_association(SCI_OBJECT_HANDLE_T object)72 void * sci_object_get_association(
73    SCI_OBJECT_HANDLE_T object
74 )
75 {
76    return ((SCI_BASE_OBJECT_T *) object)->associated_object;
77 }
78 #endif
79 
80 // ---------------------------------------------------------------------------
81 
82 #if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS)
sci_object_set_association(SCI_OBJECT_HANDLE_T object,void * associated_object)83 SCI_STATUS sci_object_set_association(
84    SCI_OBJECT_HANDLE_T   object,
85    void                * associated_object
86 )
87 {
88    ((SCI_BASE_OBJECT_T *)object)->associated_object = associated_object;
89    return SCI_SUCCESS;
90 }
91 #endif
92 
93 // ---------------------------------------------------------------------------
94 
sci_base_object_construct(SCI_BASE_OBJECT_T * base_object,struct SCI_BASE_LOGGER * logger)95 void sci_base_object_construct(
96    SCI_BASE_OBJECT_T      * base_object,
97    struct SCI_BASE_LOGGER * logger
98 )
99 {
100 #if defined(SCI_LOGGING)
101    base_object->logger = logger;
102 #endif // defined(SCI_LOGGING)
103    base_object->associated_object = NULL;
104 }
105 
106 // ---------------------------------------------------------------------------
107 
sci_object_get_logger(SCI_OBJECT_HANDLE_T object)108 SCI_LOGGER_HANDLE_T sci_object_get_logger(
109    SCI_OBJECT_HANDLE_T object
110 )
111 {
112 #if defined(SCI_LOGGING)
113    return sci_base_object_get_logger(object);
114 #else // defined(SCI_LOGGING)
115    return NULL;
116 #endif // defined(SCI_LOGGING)
117 }
118 
119