FreeBSD/Linux Kernel Cross Reference
sys/dev/isci/scil/sci_base_state_machine.h

     /*-
      * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
      *
      * This file is provided under a dual BSD/GPLv2 license.  When using or
      * redistributing this file, you may do so under either license.
      *
      * GPL LICENSE SUMMARY
      *
      * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
     *
     * This program is free software; you can redistribute it and/or modify
     * it under the terms of version 2 of the GNU General Public License as
     * published by the Free Software Foundation.
     *
     * This program is distributed in the hope that it will be useful, but
     * WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     * General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
     * The full GNU General Public License is included in this distribution
     * in the file called LICENSE.GPL.
     *
     * BSD LICENSE
     *
     * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
     * All rights reserved.
     *
     * Redistribution and use in source and binary forms, with or without
     * modification, are permitted provided that the following conditions
     * are met:
     *
     *   * Redistributions of source code must retain the above copyright
     *     notice, this list of conditions and the following disclaimer.
     *   * Redistributions in binary form must reproduce the above copyright
     *     notice, this list of conditions and the following disclaimer in
     *     the documentation and/or other materials provided with the
     *     distribution.
     *
     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     *
     * $FreeBSD$
     */
    #ifndef _SCI_BASE_STATE_MACHINE_H_
    #define _SCI_BASE_STATE_MACHINE_H_
    
    /**
     * @file
     *
     * @brief This file contains all structures, constants, or method declarations
     *        common to all state machines defined in SCI.
     */
    
    #ifdef __cplusplus
    extern "C" {
    #endif // __cplusplus
    
    #include <dev/isci/scil/sci_base_subject.h>
    #include <dev/isci/scil/sci_base_state.h>
    
    
    /**
     * This macro simply provides simplified retrieval of an objects state
     * handler.
     */
    #define SET_STATE_HANDLER(object, table, state) \
       (object)->state_handlers = &(table)[(state)]
    
    /**
     * @struct SCI_BASE_STATE_MACHINE
     *
     * @brief This structure defines the fields common to all state machines.
     */
    typedef struct SCI_BASE_STATE_MACHINE
    {
    #if defined(SCI_LOGGING)
       /**
        * The state machine object participates in the observer design pattern.
        * Thus, the SCI_BASE_SUBJECT is the parent object, which allows a
        * state machine to be easily monitored by a user.
        */
       SCI_BASE_SUBJECT_T parent;
    #endif // defined(SCI_LOGGING)
    
       /**
        * This field points to the start of the state machine's state table.
        */
      SCI_BASE_STATE_T * state_table;
   
      /**
       * This field points to the object to which this state machine is
       * associated.  It serves as a cookie to be provided to the state
       * enter/exit methods.
       */
      SCI_BASE_OBJECT_T * state_machine_owner;
   
      /**
       * This field simply indicates the state value for the state machine's
       * initial state.
       */
      U32  initial_state_id;
   
      /**
       * This field indicates the current state of the state machine.
       */
      U32  current_state_id;
   
      /**
       * This field indicates the previous state of the state machine.
       */
      U32  previous_state_id;
   
   } SCI_BASE_STATE_MACHINE_T;
   
   //******************************************************************************
   //* P R O T E C T E D    M E T H O D S
   //******************************************************************************
   
   void sci_base_state_machine_construct(
      SCI_BASE_STATE_MACHINE_T *this_state_machine,
      SCI_BASE_OBJECT_T        *state_machine_owner,
      SCI_BASE_STATE_T         *state_table,
      U32                       initial_state
   );
   
   void sci_base_state_machine_start(
      SCI_BASE_STATE_MACHINE_T *this_state_machine
   );
   
   void sci_base_state_machine_stop(
      SCI_BASE_STATE_MACHINE_T *this_state_machine
   );
   
   void sci_base_state_machine_change_state(
      SCI_BASE_STATE_MACHINE_T *this_state_machine,
      U32                       next_state
   );
   
   U32 sci_base_state_machine_get_state(
      SCI_BASE_STATE_MACHINE_T *this_state_machine
   );
   
   #ifdef __cplusplus
   }
   #endif // __cplusplus
   
   #endif // _SCI_BASE_STATE_MACHINE_H_

Cache object: 3bbd2f6fa3378b756517dc8f3010387f