sci_base_state_machine_observer.c revision 330897 
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__FBSDID("$FreeBSD: stable/11/sys/dev/isci/scil/sci_base_state_machine_observer.c 330897 2018-03-14 03:19:51Z eadler $");
57
58/**
59 * @file
60 *
61 * @brief This file provides the implementation for the observer role
62 *        for a state machine.  A state machine observer is notified when
63 *        the state machine changes states.
64 */
65
66#include <dev/isci/scil/sci_base_state_machine.h>
67#include <dev/isci/scil/sci_base_state_machine_observer.h>
68
69#if defined(SCI_LOGGING)
70
71#define SCI_BASE_INVALID_SUBJECT_STATE 0xFFFF
72
73//******************************************************************************
74//* P R O T E C T E D    M E T H O D S
75//******************************************************************************
76
77void sci_base_state_machine_observer_default_update(
78   SCI_BASE_OBSERVER_T *this_observer,
79   SCI_BASE_SUBJECT_T  *the_subject
80)
81{
82   SCI_BASE_STATE_MACHINE_OBSERVER_T *state_machine_observer;
83
84   state_machine_observer = (SCI_BASE_STATE_MACHINE_OBSERVER_T *)this_observer;
85
86   state_machine_observer->subject_state =
87      sci_base_state_machine_get_state((SCI_BASE_STATE_MACHINE_T *)the_subject);
88}
89
90// ---------------------------------------------------------------------------
91
92void sci_base_state_machine_observer_construct(
93   SCI_BASE_STATE_MACHINE_OBSERVER_T *this_observer
94)
95{
96   this_observer->parent.update = sci_base_state_machine_observer_default_update;
97
98   this_observer->subject_state = SCI_BASE_INVALID_SUBJECT_STATE;
99}
100
101#endif // defined(SCI_LOGGING)
102