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 67 #include "isci.h" 68 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 78 #define SCU_HARDWARE_SUSPENSION (0) 79 #define SCI_SOFTWARE_SUSPENSION (1) 80 81 struct isci_request; 82 struct isci_remote_device; 83 struct sci_remote_node_context; 84 85 typedef void (*scics_sds_remote_node_context_callback)(void *); 86 87 /** 88 * This is the enumeration of the remote node context states. 89 */ 90 enum scis_sds_remote_node_context_states { 91 /** 92 * This state is the initial state for a remote node context. On a resume 93 * request the remote node context will transition to the posting state. 94 */ 95 SCI_RNC_INITIAL, 96 97 /** 98 * This is a transition state that posts the RNi to the hardware. Once the RNC 99 * is posted the remote node context will be made ready. 100 */ 101 SCI_RNC_POSTING, 102 103 /** 104 * This is a transition state that will post an RNC invalidate to the 105 * hardware. Once the invalidate is complete the remote node context will 106 * transition to the posting state. 107 */ 108 SCI_RNC_INVALIDATING, 109 110 /** 111 * This is a transition state that will post an RNC resume to the hardare. 112 * Once the event notification of resume complete is received the remote node 113 * context will transition to the ready state. 114 */ 115 SCI_RNC_RESUMING, 116 117 /** 118 * This is the state that the remote node context must be in to accept io 119 * request operations. 120 */ 121 SCI_RNC_READY, 122 123 /** 124 * This is the state that the remote node context transitions to when it gets 125 * a TX suspend notification from the hardware. 126 */ 127 SCI_RNC_TX_SUSPENDED, 128 129 /** 130 * This is the state that the remote node context transitions to when it gets 131 * a TX RX suspend notification from the hardware. 132 */ 133 SCI_RNC_TX_RX_SUSPENDED, 134 135 /** 136 * This state is a wait state for the remote node context that waits for a 137 * suspend notification from the hardware. This state is entered when either 138 * there is a request to supend the remote node context or when there is a TC 139 * completion where the remote node will be suspended by the hardware. 140 */ 141 SCI_RNC_AWAIT_SUSPENSION 142 }; 143 144 /** 145 * 146 * 147 * This enumeration is used to define the end destination state for the remote 148 * node context. 149 */ 150 enum sci_remote_node_context_destination_state { 151 SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED, 152 SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY, 153 SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL 154 }; 155 156 /** 157 * struct sci_remote_node_context - This structure contains the data 158 * associated with the remote node context object. The remote node context 159 * (RNC) object models the the remote device information necessary to manage 160 * the silicon RNC. 161 */ 162 struct sci_remote_node_context { 163 /** 164 * This field indicates the remote node index (RNI) associated with 165 * this RNC. 166 */ 167 u16 remote_node_index; 168 169 /** 170 * This field is the recored suspension code or the reason for the remote node 171 * context suspension. 172 */ 173 u32 suspension_code; 174 175 /** 176 * This field is true if the remote node context is resuming from its current 177 * state. This can cause an automatic resume on receiving a suspension 178 * notification. 179 */ 180 enum sci_remote_node_context_destination_state destination_state; 181 182 /** 183 * This field contains the callback function that the user requested to be 184 * called when the requested state transition is complete. 185 */ 186 scics_sds_remote_node_context_callback user_callback; 187 188 /** 189 * This field contains the parameter that is called when the user requested 190 * state transition is completed. 191 */ 192 void *user_cookie; 193 194 /** 195 * This field contains the data for the object's state machine. 196 */ 197 struct sci_base_state_machine sm; 198 }; 199 200 void sci_remote_node_context_construct(struct sci_remote_node_context *rnc, 201 u16 remote_node_index); 202 203 204 bool sci_remote_node_context_is_ready( 205 struct sci_remote_node_context *sci_rnc); 206 207 enum sci_status sci_remote_node_context_event_handler(struct sci_remote_node_context *sci_rnc, 208 u32 event_code); 209 enum sci_status sci_remote_node_context_destruct(struct sci_remote_node_context *sci_rnc, 210 scics_sds_remote_node_context_callback callback, 211 void *callback_parameter); 212 enum sci_status sci_remote_node_context_suspend(struct sci_remote_node_context *sci_rnc, 213 u32 suspend_type, 214 scics_sds_remote_node_context_callback cb_fn, 215 void *cb_p); 216 enum sci_status sci_remote_node_context_resume(struct sci_remote_node_context *sci_rnc, 217 scics_sds_remote_node_context_callback cb_fn, 218 void *cb_p); 219 enum sci_status sci_remote_node_context_start_task(struct sci_remote_node_context *sci_rnc, 220 struct isci_request *ireq); 221 enum sci_status sci_remote_node_context_start_io(struct sci_remote_node_context *sci_rnc, 222 struct isci_request *ireq); 223 224 #endif /* _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ */ 225