1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD: releng/11.0/sys/dev/isci/scil/sci_base_state_machine.h 231136 2012-02-07 17:43:58Z jimharris $ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_BASE_STATE_MACHINE_H_ 55230557Sjimharris#define _SCI_BASE_STATE_MACHINE_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all structures, constants, or method declarations 61230557Sjimharris * common to all state machines defined in SCI. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/sci_base_subject.h> 69230557Sjimharris#include <dev/isci/scil/sci_base_state.h> 70230557Sjimharris 71230557Sjimharris 72230557Sjimharris/** 73230557Sjimharris * This macro simply provides simplified retrieval of an objects state 74230557Sjimharris * handler. 75230557Sjimharris */ 76230557Sjimharris#define SET_STATE_HANDLER(object, table, state) \ 77230557Sjimharris (object)->state_handlers = &(table)[(state)] 78230557Sjimharris 79230557Sjimharris/** 80230557Sjimharris * @struct SCI_BASE_STATE_MACHINE 81230557Sjimharris * 82230557Sjimharris * @brief This structure defines the fields common to all state machines. 83230557Sjimharris */ 84230557Sjimharristypedef struct SCI_BASE_STATE_MACHINE 85230557Sjimharris{ 86230557Sjimharris#if defined(SCI_LOGGING) 87230557Sjimharris /** 88230557Sjimharris * The state machine object participates in the observer design pattern. 89230557Sjimharris * Thus, the SCI_BASE_SUBJECT is the parent object, which allows a 90230557Sjimharris * state machine to be easily monitored by a user. 91230557Sjimharris */ 92230557Sjimharris SCI_BASE_SUBJECT_T parent; 93230557Sjimharris#endif // defined(SCI_LOGGING) 94230557Sjimharris 95230557Sjimharris /** 96230557Sjimharris * This field points to the start of the state machine's state table. 97230557Sjimharris */ 98230557Sjimharris SCI_BASE_STATE_T * state_table; 99230557Sjimharris 100230557Sjimharris /** 101230557Sjimharris * This field points to the object to which this state machine is 102230557Sjimharris * associated. It serves as a cookie to be provided to the state 103230557Sjimharris * enter/exit methods. 104230557Sjimharris */ 105230557Sjimharris SCI_BASE_OBJECT_T * state_machine_owner; 106230557Sjimharris 107230557Sjimharris /** 108230557Sjimharris * This field simply indicates the state value for the state machine's 109230557Sjimharris * initial state. 110230557Sjimharris */ 111230557Sjimharris U32 initial_state_id; 112230557Sjimharris 113230557Sjimharris /** 114230557Sjimharris * This field indicates the current state of the state machine. 115230557Sjimharris */ 116230557Sjimharris U32 current_state_id; 117230557Sjimharris 118230557Sjimharris /** 119230557Sjimharris * This field indicates the previous state of the state machine. 120230557Sjimharris */ 121230557Sjimharris U32 previous_state_id; 122230557Sjimharris 123230557Sjimharris} SCI_BASE_STATE_MACHINE_T; 124230557Sjimharris 125230557Sjimharris//****************************************************************************** 126230557Sjimharris//* P R O T E C T E D M E T H O D S 127230557Sjimharris//****************************************************************************** 128230557Sjimharris 129230557Sjimharrisvoid sci_base_state_machine_construct( 130230557Sjimharris SCI_BASE_STATE_MACHINE_T *this_state_machine, 131230557Sjimharris SCI_BASE_OBJECT_T *state_machine_owner, 132230557Sjimharris SCI_BASE_STATE_T *state_table, 133230557Sjimharris U32 initial_state 134230557Sjimharris); 135230557Sjimharris 136230557Sjimharrisvoid sci_base_state_machine_start( 137230557Sjimharris SCI_BASE_STATE_MACHINE_T *this_state_machine 138230557Sjimharris); 139230557Sjimharris 140230557Sjimharrisvoid sci_base_state_machine_stop( 141230557Sjimharris SCI_BASE_STATE_MACHINE_T *this_state_machine 142230557Sjimharris); 143230557Sjimharris 144230557Sjimharrisvoid sci_base_state_machine_change_state( 145230557Sjimharris SCI_BASE_STATE_MACHINE_T *this_state_machine, 146230557Sjimharris U32 next_state 147230557Sjimharris); 148230557Sjimharris 149230557SjimharrisU32 sci_base_state_machine_get_state( 150230557Sjimharris SCI_BASE_STATE_MACHINE_T *this_state_machine 151230557Sjimharris); 152230557Sjimharris 153230557Sjimharris#ifdef __cplusplus 154230557Sjimharris} 155230557Sjimharris#endif // __cplusplus 156230557Sjimharris 157230557Sjimharris#endif // _SCI_BASE_STATE_MACHINE_H_ 158