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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
54 #ifndef _SCI_BASE_STATE_MACHINE_OBSERVER_H_
55 #define _SCI_BASE_STATE_MACHINE_OBSERVER_H_
60 * @brief This file contains all of the structures, constants, and methods
61 * common to all state machine observer object definitions.
68 #include <dev/isci/scil/sci_base_observer.h>
69 #include <dev/isci/scil/sci_base_subject.h>
71 #if defined(SCI_LOGGING)
74 * @struct SCI_BASE_STATE_MACHINE_OBSERVER
76 * @brief The base state machine observer structure defines the fields
77 * necessary for a user that wishes to observe the behavior (i.e.
78 * state changes) of a state machine.
80 typedef struct SCI_BASE_STATE_MACHINE_OBSERVER
83 * The field specifies that the parent object for the base state
84 * machine observer is the base observer itself.
86 SCI_BASE_OBSERVER_T parent;
89 * This field contains the state recorded during the last state machine
94 } SCI_BASE_STATE_MACHINE_OBSERVER_T;
97 * @brief This method provides default behavior for a state machine observer.
98 * This method records the state of the subject (i.e. the state
99 * machine) and returns.
101 * @param[in] this_observer This parameter specifes the state machine
102 * observer in which to record the state change from the subject.
103 * @param[in] the_subject This parameter evaluates to the state machine
104 * object under observation.
108 void sci_base_state_machine_observer_default_update(
109 SCI_BASE_OBSERVER_T *this_observer,
110 SCI_BASE_SUBJECT_T *the_subject
114 * @brief This method constructs the supplied state machine observer.
116 * @param[in] this_observer This parameter specifes the state machine
117 * observer to be constructed.
121 void sci_base_state_machine_observer_construct(
122 SCI_BASE_STATE_MACHINE_OBSERVER_T *this_observer
125 #else // defined(SCI_LOGGING)
127 typedef U8 SCI_BASE_STATE_MACHINE_OBSERVER_T;
129 #define sci_base_state_machine_observer_default_update
130 #define sci_base_state_machine_observer_construct
132 #endif // defined(SCI_LOGGING)
136 #endif // __cplusplus
138 #endif // _SCI_BASE_STATE_MACHINE_OBSERVER_H_