[deliverable/linux.git] / drivers / scsi / isci / remote_node_context.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 _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
#define _SCIC_SDS_REMOTE_NODE_CONTEXT_H_

/**
 * This file contains the structures, constants, and prototypes associated with
 *    the remote node context in the silicon.  It exists to model and manage
 *    the remote node context in the silicon.
 *
 *
 */

#include "isci.h"

/**
 *
 *
 * This constant represents an invalid remote device id, it is used to program
 * the STPDARNI register so the driver knows when it has received a SIGNATURE
 * FIS from the SCU.
 */
#define SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX    0x0FFF

enum sci_remote_node_suspension_reasons {
	SCU_HARDWARE_SUSPENSION,
	SCI_SOFTWARE_SUSPENSION
};
#define SCI_SOFTWARE_SUSPEND_CMD SCU_CONTEXT_COMMAND_POST_RNC_SUSPEND_TX_RX
#define SCI_SOFTWARE_SUSPEND_EXPECTED_EVENT SCU_EVENT_TL_RNC_SUSPEND_TX_RX

struct isci_request;
struct isci_remote_device;
struct sci_remote_node_context;

typedef void (*scics_sds_remote_node_context_callback)(void *);

/**
 * enum sci_remote_node_context_states
 * @SCI_RNC_INITIAL initial state for a remote node context.  On a resume
 * request the remote node context will transition to the posting state.
 *
 * @SCI_RNC_POSTING: transition state that posts the RNi to the hardware. Once
 * the RNC is posted the remote node context will be made ready.
 *
 * @SCI_RNC_INVALIDATING: transition state that will post an RNC invalidate to
 * the hardware.  Once the invalidate is complete the remote node context will
 * transition to the posting state.
 *
 * @SCI_RNC_RESUMING: transition state that will post an RNC resume to the
 * hardare.  Once the event notification of resume complete is received the
 * remote node context will transition to the ready state.
 *
 * @SCI_RNC_READY: state that the remote node context must be in to accept io
 * request operations.
 *
 * @SCI_RNC_TX_SUSPENDED: state that the remote node context transitions to when
 * it gets a TX suspend notification from the hardware.
 *
 * @SCI_RNC_TX_RX_SUSPENDED: state that the remote node context transitions to
 * when it gets a TX RX suspend notification from the hardware.
 *
 * @SCI_RNC_AWAIT_SUSPENSION: wait state for the remote node context that waits
 * for a suspend notification from the hardware.  This state is entered when
 * either there is a request to supend the remote node context or when there is
 * a TC completion where the remote node will be suspended by the hardware.
 */
#define RNC_STATES {\
	C(RNC_INITIAL),\
	C(RNC_POSTING),\
	C(RNC_INVALIDATING),\
	C(RNC_RESUMING),\
	C(RNC_READY),\
	C(RNC_TX_SUSPENDED),\
	C(RNC_TX_RX_SUSPENDED),\
	C(RNC_AWAIT_SUSPENSION),\
	}
#undef C
#define C(a) SCI_##a
enum scis_sds_remote_node_context_states RNC_STATES;
#undef C
const char *rnc_state_name(enum scis_sds_remote_node_context_states state);

/**
 *
 *
 * This enumeration is used to define the end destination state for the remote
 * node context.
 */
enum sci_remote_node_context_destination_state {
	SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED,
	SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY,
	SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL
};

/**
 * struct sci_remote_node_context - This structure contains the data
 *    associated with the remote node context object.  The remote node context
 *    (RNC) object models the the remote device information necessary to manage
 *    the silicon RNC.
 */
struct sci_remote_node_context {
	/**
	 * This field indicates the remote node index (RNI) associated with
	 * this RNC.
	 */
	u16 remote_node_index;

	/**
	 * This field is the recored suspension type of the remote node
	 * context suspension.
	 */
	u32 suspend_type;

	/**
	 * This field is true if the remote node context is resuming from its current
	 * state.  This can cause an automatic resume on receiving a suspension
	 * notification.
	 */
	enum sci_remote_node_context_destination_state destination_state;

	/**
	 * This field contains the callback function that the user requested to be
	 * called when the requested state transition is complete.
	 */
	scics_sds_remote_node_context_callback user_callback;

	/**
	 * This field contains the parameter that is called when the user requested
	 * state transition is completed.
	 */
	void *user_cookie;

	/**
	 * This field contains the data for the object's state machine.
	 */
	struct sci_base_state_machine sm;
};

void sci_remote_node_context_construct(struct sci_remote_node_context *rnc,
					    u16 remote_node_index);


bool sci_remote_node_context_is_ready(
	struct sci_remote_node_context *sci_rnc);

enum sci_status sci_remote_node_context_event_handler(struct sci_remote_node_context *sci_rnc,
							   u32 event_code);
enum sci_status sci_remote_node_context_destruct(struct sci_remote_node_context *sci_rnc,
						      scics_sds_remote_node_context_callback callback,
						      void *callback_parameter);
enum sci_status sci_remote_node_context_suspend(struct sci_remote_node_context *sci_rnc,
						     u32 suspend_type,
						     u32 suspension_code,
						     scics_sds_remote_node_context_callback cb_fn,
						     void *cb_p);
enum sci_status sci_remote_node_context_resume(struct sci_remote_node_context *sci_rnc,
						    scics_sds_remote_node_context_callback cb_fn,
						    void *cb_p);
enum sci_status sci_remote_node_context_start_task(struct sci_remote_node_context *sci_rnc,
							struct isci_request *ireq);
enum sci_status sci_remote_node_context_start_io(struct sci_remote_node_context *sci_rnc,
						      struct isci_request *ireq);

#endif  /* _SCIC_SDS_REMOTE_NODE_CONTEXT_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 _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
	57	#define _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
	58
	59	/**
	60	* This file contains the structures, constants, and prototypes associated with
	61	* the remote node context in the silicon. It exists to model and manage
	62	* the remote node context in the silicon.
	63	*
	64	*
65	*/
66
12ef6544	67	#include "isci.h"
6f231dda	68
6f231dda DW	69	/**
	70	*
	71	*
	72	* This constant represents an invalid remote device id, it is used to program
	73	* the STPDARNI register so the driver knows when it has received a SIGNATURE
	74	* FIS from the SCU.
	75	*/
	76	#define SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX 0x0FFF
	77
ac78ed0f JS	78	enum sci_remote_node_suspension_reasons {
	79	SCU_HARDWARE_SUSPENSION,
	80	SCI_SOFTWARE_SUSPENSION
	81	};
	82	#define SCI_SOFTWARE_SUSPEND_CMD SCU_CONTEXT_COMMAND_POST_RNC_SUSPEND_TX_RX
	83	#define SCI_SOFTWARE_SUSPEND_EXPECTED_EVENT SCU_EVENT_TL_RNC_SUSPEND_TX_RX
6f231dda	84
5076a1a9	85	struct isci_request;
78a6f06e	86	struct isci_remote_device;
89a7301f	87	struct sci_remote_node_context;
6f231dda	88
7fbafaa5	89	typedef void (scics_sds_remote_node_context_callback)(void );
6f231dda	90
6f231dda	91	/**
d7a0ccdd DW	92	* enum sci_remote_node_context_states
	93	* @SCI_RNC_INITIAL initial state for a remote node context. On a resume
	94	* request the remote node context will transition to the posting state.
	95	*
	96	* @SCI_RNC_POSTING: transition state that posts the RNi to the hardware. Once
	97	* the RNC is posted the remote node context will be made ready.
	98	*
	99	* @SCI_RNC_INVALIDATING: transition state that will post an RNC invalidate to
	100	* the hardware. Once the invalidate is complete the remote node context will
	101	* transition to the posting state.
	102	*
	103	* @SCI_RNC_RESUMING: transition state that will post an RNC resume to the
	104	* hardare. Once the event notification of resume complete is received the
	105	* remote node context will transition to the ready state.
	106	*
	107	* @SCI_RNC_READY: state that the remote node context must be in to accept io
	108	* request operations.
	109	*
	110	* @SCI_RNC_TX_SUSPENDED: state that the remote node context transitions to when
	111	* it gets a TX suspend notification from the hardware.
	112	*
	113	* @SCI_RNC_TX_RX_SUSPENDED: state that the remote node context transitions to
	114	* when it gets a TX RX suspend notification from the hardware.
	115	*
	116	* @SCI_RNC_AWAIT_SUSPENSION: wait state for the remote node context that waits
	117	* for a suspend notification from the hardware. This state is entered when
	118	* either there is a request to supend the remote node context or when there is
	119	* a TC completion where the remote node will be suspended by the hardware.
6f231dda	120	*/
d7a0ccdd DW	121	#define RNC_STATES {\
	122	C(RNC_INITIAL),\
	123	C(RNC_POSTING),\
	124	C(RNC_INVALIDATING),\
	125	C(RNC_RESUMING),\
	126	C(RNC_READY),\
	127	C(RNC_TX_SUSPENDED),\
	128	C(RNC_TX_RX_SUSPENDED),\
	129	C(RNC_AWAIT_SUSPENSION),\
	130	}
	131	#undef C
	132	#define C(a) SCI_##a
	133	enum scis_sds_remote_node_context_states RNC_STATES;
	134	#undef C
	135	const char *rnc_state_name(enum scis_sds_remote_node_context_states state);
6f231dda DW	136
	137	/**
	138	*
	139	*
	140	* This enumeration is used to define the end destination state for the remote
	141	* node context.
	142	*/
89a7301f	143	enum sci_remote_node_context_destination_state {
6f231dda DW	144	SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED,
	145	SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY,
	146	SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL
	147	};
	148
	149	/**
89a7301f	150	* struct sci_remote_node_context - This structure contains the data
6f231dda DW	151	* associated with the remote node context object. The remote node context
	152	* (RNC) object models the the remote device information necessary to manage
	153	* the silicon RNC.
6f231dda	154	*/
89a7301f	155	struct sci_remote_node_context {
6f231dda DW	156	/**
	157	* This field indicates the remote node index (RNI) associated with
	158	* this RNC.
	159	*/
	160	u16 remote_node_index;
	161
	162	/**
ac78ed0f	163	* This field is the recored suspension type of the remote node
6f231dda DW	164	* context suspension.
6f231dda DW	165	*/
ac78ed0f	166	u32 suspend_type;
6f231dda DW	167
	168	/**
	169	* This field is true if the remote node context is resuming from its current
	170	* state. This can cause an automatic resume on receiving a suspension
	171	* notification.
	172	*/
89a7301f	173	enum sci_remote_node_context_destination_state destination_state;
6f231dda DW	174
	175	/**
	176	* This field contains the callback function that the user requested to be
	177	* called when the requested state transition is complete.
	178	*/
7fbafaa5	179	scics_sds_remote_node_context_callback user_callback;
6f231dda DW	180
	181	/**
	182	* This field contains the parameter that is called when the user requested
	183	* state transition is completed.
	184	*/
	185	void *user_cookie;
	186
	187	/**
	188	* This field contains the data for the object's state machine.
	189	*/
e301370a	190	struct sci_base_state_machine sm;
6f231dda DW	191	};
6f231dda DW	192
89a7301f	193	void sci_remote_node_context_construct(struct sci_remote_node_context *rnc,
9614395e	194	u16 remote_node_index);
6f231dda	195
6f231dda	196
89a7301f DW	197	bool sci_remote_node_context_is_ready(
89a7301f DW	198	struct sci_remote_node_context *sci_rnc);
6f231dda	199
89a7301f	200	enum sci_status sci_remote_node_context_event_handler(struct sci_remote_node_context *sci_rnc,
338e386d	201	u32 event_code);
89a7301f	202	enum sci_status sci_remote_node_context_destruct(struct sci_remote_node_context *sci_rnc,
c845ae96 DW	203	scics_sds_remote_node_context_callback callback,
c845ae96 DW	204	void *callback_parameter);
89a7301f	205	enum sci_status sci_remote_node_context_suspend(struct sci_remote_node_context *sci_rnc,
ed3efb77	206	u32 suspend_type,
ac78ed0f	207	u32 suspension_code,
ed3efb77 DW	208	scics_sds_remote_node_context_callback cb_fn,
ed3efb77 DW	209	void *cb_p);
89a7301f	210	enum sci_status sci_remote_node_context_resume(struct sci_remote_node_context *sci_rnc,
ed3efb77 DW	211	scics_sds_remote_node_context_callback cb_fn,
ed3efb77 DW	212	void *cb_p);
89a7301f	213	enum sci_status sci_remote_node_context_start_task(struct sci_remote_node_context *sci_rnc,
5076a1a9	214	struct isci_request *ireq);
89a7301f	215	enum sci_status sci_remote_node_context_start_io(struct sci_remote_node_context *sci_rnc,
5076a1a9	216	struct isci_request *ireq);
6f231dda	217
6f231dda	218	#endif /* _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ */