e301370ac5
This cleans up several areas of the state machine mechanism:
o Rename sci_base_state_machine_change_state to sci_change_state
o Remove sci_base_state_machine_get_state function
o Rename 'state_machine' struct member to 'sm' in client structs
o Shorten the name of request states
o Shorten state machine state names as follows:
SCI_BASE_CONTROLLER_STATE_xxx to SCIC_xxx
SCI_BASE_PHY_STATE_xxx to SCI_PHY_xxx
SCIC_SDS_PHY_STARTING_SUBSTATE_xxx to SCI_PHY_SUB_xxx
SCI_BASE_PORT_STATE_xxx to SCI_PORT_xxx and
SCIC_SDS_PORT_READY_SUBSTATE_xxx to SCI_PORT_SUB_xxx
SCI_BASE_REMOTE_DEVICE_STATE_xxx to SCI_DEV_xxx
SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_xxx to SCI_STP_DEV_xxx
SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_xxx to SCI_SMP_DEV_xxx
SCIC_SDS_REMOTE_NODE_CONTEXT_xxx_STATE to SCI_RNC_xxx
Signed-off-by: Edmund Nadolski <edmund.nadolski@intel.com>
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
228 lines
7.9 KiB
C
228 lines
7.9 KiB
C
/*
|
|
* 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 "state_machine.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
|
|
|
|
#define SCU_HARDWARE_SUSPENSION (0)
|
|
#define SCI_SOFTWARE_SUSPENSION (1)
|
|
|
|
struct scic_sds_request;
|
|
struct scic_sds_remote_device;
|
|
struct scic_sds_remote_node_context;
|
|
|
|
typedef void (*scics_sds_remote_node_context_callback)(void *);
|
|
|
|
/**
|
|
* This is the enumeration of the remote node context states.
|
|
*/
|
|
enum scis_sds_remote_node_context_states {
|
|
/**
|
|
* This state is the initial state for a remote node context. On a resume
|
|
* request the remote node context will transition to the posting state.
|
|
*/
|
|
SCI_RNC_INITIAL,
|
|
|
|
/**
|
|
* This is a transition state that posts the RNi to the hardware. Once the RNC
|
|
* is posted the remote node context will be made ready.
|
|
*/
|
|
SCI_RNC_POSTING,
|
|
|
|
/**
|
|
* This is a 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_INVALIDATING,
|
|
|
|
/**
|
|
* This is a 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_RESUMING,
|
|
|
|
/**
|
|
* This is the state that the remote node context must be in to accept io
|
|
* request operations.
|
|
*/
|
|
SCI_RNC_READY,
|
|
|
|
/**
|
|
* This is the state that the remote node context transitions to when it gets
|
|
* a TX suspend notification from the hardware.
|
|
*/
|
|
SCI_RNC_TX_SUSPENDED,
|
|
|
|
/**
|
|
* This is the state that the remote node context transitions to when it gets
|
|
* a TX RX suspend notification from the hardware.
|
|
*/
|
|
SCI_RNC_TX_RX_SUSPENDED,
|
|
|
|
/**
|
|
* This state is a 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.
|
|
*/
|
|
SCI_RNC_AWAIT_SUSPENSION
|
|
};
|
|
|
|
/**
|
|
*
|
|
*
|
|
* This enumeration is used to define the end destination state for the remote
|
|
* node context.
|
|
*/
|
|
enum scic_sds_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 scic_sds_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 scic_sds_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 code or the reason for the remote node
|
|
* context suspension.
|
|
*/
|
|
u32 suspension_code;
|
|
|
|
/**
|
|
* 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 scic_sds_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 scic_sds_remote_node_context_construct(struct scic_sds_remote_node_context *rnc,
|
|
u16 remote_node_index);
|
|
|
|
|
|
bool scic_sds_remote_node_context_is_ready(
|
|
struct scic_sds_remote_node_context *sci_rnc);
|
|
|
|
#define scic_sds_remote_node_context_get_remote_node_index(rcn) \
|
|
((rnc)->remote_node_index)
|
|
|
|
enum sci_status scic_sds_remote_node_context_event_handler(struct scic_sds_remote_node_context *sci_rnc,
|
|
u32 event_code);
|
|
enum sci_status scic_sds_remote_node_context_destruct(struct scic_sds_remote_node_context *sci_rnc,
|
|
scics_sds_remote_node_context_callback callback,
|
|
void *callback_parameter);
|
|
enum sci_status scic_sds_remote_node_context_suspend(struct scic_sds_remote_node_context *sci_rnc,
|
|
u32 suspend_type,
|
|
scics_sds_remote_node_context_callback cb_fn,
|
|
void *cb_p);
|
|
enum sci_status scic_sds_remote_node_context_resume(struct scic_sds_remote_node_context *sci_rnc,
|
|
scics_sds_remote_node_context_callback cb_fn,
|
|
void *cb_p);
|
|
enum sci_status scic_sds_remote_node_context_start_task(struct scic_sds_remote_node_context *sci_rnc,
|
|
struct scic_sds_request *sci_req);
|
|
enum sci_status scic_sds_remote_node_context_start_io(struct scic_sds_remote_node_context *sci_rnc,
|
|
struct scic_sds_request *sci_req);
|
|
|
|
#endif /* _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ */
|