[deliverable/linux.git] / drivers / scsi / isci / state_machine.h

/*
 * 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.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * 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.
 */

#ifndef _SCI_BASE_STATE_MACHINE_H_
#define _SCI_BASE_STATE_MACHINE_H_

#include <linux/types.h>

typedef void (*sci_base_state_handler_t)(void);

typedef void (*sci_state_transition_t)(void *base_object);

/**
 * struct sci_base_state - The base state object abstracts the fields common to
 *    all state objects defined in SCI.
 *
 *
 */
struct sci_base_state {
	/**
	 * This field is a function pointer that defines the method to be
	 * invoked when the state is entered.
	 */
	sci_state_transition_t enter_state;

	/**
	 * This field is a function pointer that defines the method to be
	 * invoked when the state is exited.
	 */
	sci_state_transition_t exit_state;

};

/**
 * struct sci_base_state_machine - This structure defines the fields common to
 *    all state machines.
 *
 *
 */
struct sci_base_state_machine {
	/**
	 * This field points to the start of the state machine's state table.
	 */
	const struct sci_base_state *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.
	 */
	void *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;

};

/*
 * ******************************************************************************
 * * P R O T E C T E D    M E T H O D S
 * ****************************************************************************** */

void sci_base_state_machine_construct(
	struct sci_base_state_machine *this_state_machine,
	void *state_machine_owner,
	const struct sci_base_state *state_table,
	u32 initial_state);

void sci_base_state_machine_start(
	struct sci_base_state_machine *this_state_machine);

void sci_base_state_machine_stop(
	struct sci_base_state_machine *this_state_machine);

void sci_base_state_machine_change_state(
	struct sci_base_state_machine *this_state_machine,
	u32 next_state);

u32 sci_base_state_machine_get_state(
	struct sci_base_state_machine *this_state_machine);

#endif /* _SCI_BASE_STATE_MACHINE_H_ */
Commit	Line	Data
6f231dda DW	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
3bff9d54 DW	59	#include <linux/types.h>
	60
	61	typedef void (*sci_base_state_handler_t)(void);
	62
	63	typedef void (sci_state_transition_t)(void base_object);
b5739b60	64
6f231dda	65	/**
3bff9d54 DW	66	* struct sci_base_state - The base state object abstracts the fields common to
3bff9d54 DW	67	* all state objects defined in SCI.
6f231dda DW	68	*
	69	*
	70	*/
3bff9d54 DW	71	struct sci_base_state {
	72	/**
	73	* This field is a function pointer that defines the method to be
	74	* invoked when the state is entered.
	75	*/
	76	sci_state_transition_t enter_state;
6f231dda	77
3bff9d54 DW	78	/**
	79	* This field is a function pointer that defines the method to be
	80	* invoked when the state is exited.
	81	*/
	82	sci_state_transition_t exit_state;
6f231dda	83
3bff9d54	84	};
6f231dda	85
6f231dda DW	86	/**
	87	* struct sci_base_state_machine - This structure defines the fields common to
	88	* all state machines.
	89	*
	90	*
	91	*/
	92	struct sci_base_state_machine {
	93	/**
	94	* This field points to the start of the state machine's state table.
	95	*/
	96	const struct sci_base_state *state_table;
	97
	98	/**
	99	* This field points to the object to which this state machine is
	100	* associated. It serves as a cookie to be provided to the state
	101	* enter/exit methods.
	102	*/
9a0fff7b	103	void *state_machine_owner;
6f231dda DW	104
	105	/**
	106	* This field simply indicates the state value for the state machine's
	107	* initial state.
	108	*/
	109	u32 initial_state_id;
	110
	111	/**
	112	* This field indicates the current state of the state machine.
	113	*/
	114	u32 current_state_id;
	115
	116	/**
	117	* This field indicates the previous state of the state machine.
	118	*/
	119	u32 previous_state_id;
	120
	121	};
	122
	123	/*
	124	* ******************************************************************************
	125	* * P R O T E C T E D M E T H O D S
	126	* ****************************************************************************** */
	127
	128	void sci_base_state_machine_construct(
	129	struct sci_base_state_machine *this_state_machine,
9a0fff7b	130	void *state_machine_owner,
6f231dda DW	131	const struct sci_base_state *state_table,
	132	u32 initial_state);
	133
	134	void sci_base_state_machine_start(
	135	struct sci_base_state_machine *this_state_machine);
	136
	137	void sci_base_state_machine_stop(
	138	struct sci_base_state_machine *this_state_machine);
	139
	140	void sci_base_state_machine_change_state(
	141	struct sci_base_state_machine *this_state_machine,
	142	u32 next_state);
	143
	144	u32 sci_base_state_machine_get_state(
	145	struct sci_base_state_machine *this_state_machine);
	146
	147	#endif /* _SCI_BASE_STATE_MACHINE_H_ */