drivers/scsi/isci/core/sci_base_state_machine.h

   1 /*
   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.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   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.
  12  *
  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.
  17  *
  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.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  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
  38  *     distribution.
  39  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #ifndef _SCI_BASE_STATE_MACHINE_H_
  57 #define _SCI_BASE_STATE_MACHINE_H_
  58
  59 #include <linux/string.h>
  60
  61 /**
  62  * This file contains all structures, constants, or method declarations common
  63  *    to all state machines defined in SCI.
  64  *
  65  *
  66  */
  67
  68
  69 #include "sci_base_state.h"
  70
  71
  72 /**
  73  * SET_STATE_HANDLER() -
  74  *
  75  * This macro simply provides simplified retrieval of an objects state handler.
  76  */
  77 #define SET_STATE_HANDLER(object, table, state) \
  78         (object)->state_handlers = &(table)[(state)]
  79
  80 /**
  81  * struct sci_base_state_machine - This structure defines the fields common to
  82  *    all state machines.
  83  *
  84  *
  85  */
  86 struct sci_base_state_machine {
  87         /**
  88          * This field points to the start of the state machine's state table.
  89          */
  90         const struct sci_base_state *state_table;
  91
  92         /**
  93          * This field points to the object to which this state machine is
  94          * associated.  It serves as a cookie to be provided to the state
  95          * enter/exit methods.
  96          */
  97         void *state_machine_owner;
  98
  99         /**
 100          * This field simply indicates the state value for the state machine's
 101          * initial state.
 102          */
 103         u32 initial_state_id;
 104
 105         /**
 106          * This field indicates the current state of the state machine.
 107          */
 108         u32 current_state_id;
 109
 110         /**
 111          * This field indicates the previous state of the state machine.
 112          */
 113         u32 previous_state_id;
 114
 115 };
 116
 117 /*
 118  * ******************************************************************************
 119  * * P R O T E C T E D    M E T H O D S
 120  * ****************************************************************************** */
 121
 122 void sci_base_state_machine_construct(
 123         struct sci_base_state_machine *this_state_machine,
 124         void *state_machine_owner,
 125         const struct sci_base_state *state_table,
 126         u32 initial_state);
 127
 128 void sci_base_state_machine_start(
 129         struct sci_base_state_machine *this_state_machine);
 130
 131 void sci_base_state_machine_stop(
 132         struct sci_base_state_machine *this_state_machine);
 133
 134 void sci_base_state_machine_change_state(
 135         struct sci_base_state_machine *this_state_machine,
 136         u32 next_state);
 137
 138 u32 sci_base_state_machine_get_state(
 139         struct sci_base_state_machine *this_state_machine);
 140
 141 #endif /* _SCI_BASE_STATE_MACHINE_H_ */