xref: /freebsd/sys/dev/isci/scil/sci_base_observer.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 implements the functionality common to all observer
60  *        objects.
61  */
62 
63 #include <dev/isci/scil/sci_types.h>
64 #include <dev/isci/scil/sci_base_subject.h>
65 #include <dev/isci/scil/sci_base_observer.h>
66 
67 #if defined(SCI_LOGGING)
68 
69 //******************************************************************************
70 //* P U B L I C   M E T H O D S
71 //******************************************************************************
72 
sci_base_observer_construct(struct SCI_BASE_OBSERVER * this_observer,SCI_BASE_OBSERVER_UPDATE_T update)73 void sci_base_observer_construct(
74    struct SCI_BASE_OBSERVER *this_observer,
75    SCI_BASE_OBSERVER_UPDATE_T update
76 )
77 {
78    this_observer->next = NULL;
79    this_observer->update = update;
80 }
81 
82 // ---------------------------------------------------------------------------
83 
sci_base_observer_initialize(SCI_BASE_OBSERVER_T * the_observer,SCI_BASE_OBSERVER_UPDATE_T update,SCI_BASE_SUBJECT_T * the_subject)84 void sci_base_observer_initialize(
85    SCI_BASE_OBSERVER_T        * the_observer,
86    SCI_BASE_OBSERVER_UPDATE_T   update,
87    SCI_BASE_SUBJECT_T         * the_subject
88 )
89 {
90    sci_base_observer_construct(the_observer, update);
91    sci_base_subject_attach_observer(the_subject, the_observer);
92 }
93 
94 // ---------------------------------------------------------------------------
95 
sci_base_observer_update(SCI_BASE_OBSERVER_T * this_observer,SCI_BASE_SUBJECT_T * the_subject)96 void sci_base_observer_update(
97    SCI_BASE_OBSERVER_T *this_observer,
98    SCI_BASE_SUBJECT_T  *the_subject
99 )
100 {
101    if (this_observer->update != NULL)
102    {
103       this_observer->update(this_observer, the_subject);
104    }
105 }
106 
107 #endif // defined(SCI_LOGGING)
108