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