1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCIF_SAS_DOMAIN_H_ 55230557Sjimharris#define _SCIF_SAS_DOMAIN_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains the protected interface structures, constants, 61230557Sjimharris * and methods for the SCIF_SAS_DOMAIN object. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/sci_abstract_list.h> 69230557Sjimharris#include <dev/isci/scil/sci_fast_list.h> 70230557Sjimharris#include <dev/isci/scil/scif_domain.h> 71230557Sjimharris 72230557Sjimharris#include <dev/isci/scil/sci_base_domain.h> 73230557Sjimharris#include <dev/isci/scil/scif_sas_request.h> 74230557Sjimharris#include <dev/isci/scil/scif_sas_task_request.h> 75230557Sjimharris#include <dev/isci/scil/scif_sas_remote_device.h> 76230557Sjimharris 77230557Sjimharris 78230557Sjimharrisextern SCI_BASE_DOMAIN_STATE_HANDLER_T scif_sas_domain_state_handler_table[]; 79230557Sjimharrisextern SCI_BASE_STATE_T scif_sas_domain_state_table[]; 80230557Sjimharris 81230557Sjimharris#define PORT_HARD_RESET_TIMEOUT 1000 //1000 miliseconds 82230557Sjimharris 83230557Sjimharris#define SCIF_DOMAIN_DISCOVER_TIMEOUT 20000 // miliseconds 84230557Sjimharris 85230557Sjimharris/** 86230557Sjimharris * @struct SCIF_SAS_DOMAIN 87230557Sjimharris * 88230557Sjimharris * @brief The SCI SAS Framework domain object abstracts the SAS domain 89230557Sjimharris * level behavior for the framework component. Additionally, 90230557Sjimharris * it provides a higher level of abstraction for the core port 91230557Sjimharris * object. There is a 1:1 correspondance between core ports and 92230557Sjimharris * framework domain objects. Essentially, each core port provides 93230557Sjimharris * the access to the remote devices in the domain. 94230557Sjimharris */ 95230557Sjimharristypedef struct SCIF_SAS_DOMAIN 96230557Sjimharris{ 97230557Sjimharris /** 98230557Sjimharris * The SCI_BASE_DOMAIN is the parent object for the SCIF_SAS_DOMAIN 99230557Sjimharris * object. 100230557Sjimharris */ 101230557Sjimharris SCI_BASE_DOMAIN_T parent; 102230557Sjimharris 103230557Sjimharris /** 104230557Sjimharris * This field contains the handle for the SCI Core port object that 105230557Sjimharris * is managed by this framework domain object. 106230557Sjimharris */ 107230557Sjimharris SCI_PORT_HANDLE_T core_object; 108230557Sjimharris 109230557Sjimharris /** 110230557Sjimharris * This field specifies the controller containing this domain object. 111230557Sjimharris */ 112230557Sjimharris struct SCIF_SAS_CONTROLLER * controller; 113230557Sjimharris 114230557Sjimharris /** 115230557Sjimharris * This field references the list of state specific handler methods to 116230557Sjimharris * be utilized for this domain instance. 117230557Sjimharris */ 118230557Sjimharris SCI_BASE_DOMAIN_STATE_HANDLER_T * state_handlers; 119230557Sjimharris 120230557Sjimharris /** 121230557Sjimharris * This field contains references to all of the devices contained in 122230557Sjimharris * this domain. 123230557Sjimharris */ 124230557Sjimharris SCI_ABSTRACT_LIST_T remote_device_list; 125230557Sjimharris 126230557Sjimharris /** 127230557Sjimharris * This field contains the list of all outstanding request (IO or 128230557Sjimharris * management) in this domain. 129230557Sjimharris */ 130230557Sjimharris SCI_FAST_LIST_T request_list; 131230557Sjimharris 132230557Sjimharris /** 133230557Sjimharris * This field indicates whether the core port object is in a ready state 134230557Sjimharris * or not. 135230557Sjimharris */ 136230557Sjimharris BOOL is_port_ready; 137230557Sjimharris 138230557Sjimharris /** 139230557Sjimharris * This field indicates the number of remote devices that have been 140230557Sjimharris * started in this domain. 141230557Sjimharris */ 142230557Sjimharris U32 device_start_count; 143230557Sjimharris 144230557Sjimharris /** 145230557Sjimharris * This field indicates the number of remote devices that are currently 146230557Sjimharris * in the process of becoming ready. This field is utilized to gate 147230557Sjimharris * the transition back to the READY state for the domain. 148230557Sjimharris */ 149230557Sjimharris U32 device_start_in_progress_count; 150230557Sjimharris 151230557Sjimharris /** 152230557Sjimharris * This field records how many broadcast change primitve are 153230557Sjimharris * received and not processed yet. 154230557Sjimharris */ 155230557Sjimharris U32 broadcast_change_count; 156230557Sjimharris 157230557Sjimharris /** 158230557Sjimharris * This fields indicates whether the expanders in this domain need to 159230557Sjimharris * have there config route table configured by our driver. For expample, 160230557Sjimharris * if we found the top level expander is a self-configuring expander and 161230557Sjimharris * it is able to config others, all the expanders in this domain don't 162230557Sjimharris * need to configure route table. 163230557Sjimharris */ 164230557Sjimharris BOOL is_config_route_table_needed; 165230557Sjimharris 166230557Sjimharris struct 167230557Sjimharris { 168230557Sjimharris /** 169230557Sjimharris * This field provides the domain object a scratch area to indicate 170230557Sjimharris * status of an ongoing operation. 171230557Sjimharris */ 172230557Sjimharris SCI_STATUS status; 173230557Sjimharris 174230557Sjimharris /** 175230557Sjimharris * This is the timer handle that is utilized to time the discovery 176230557Sjimharris * or domain reset operations. 177230557Sjimharris */ 178230557Sjimharris void * timer; 179230557Sjimharris 180230557Sjimharris /** 181230557Sjimharris * This field specifies the timeout value, in milliseconds, for the 182230557Sjimharris * entire operation (discovery or reset). 183230557Sjimharris */ 184230557Sjimharris U32 timeout; 185230557Sjimharris 186230557Sjimharris /** 187230557Sjimharris * This field specifies the timeout value, in milliseconds, for a 188230557Sjimharris * single device. 189230557Sjimharris */ 190230557Sjimharris U32 device_timeout; 191230557Sjimharris 192230557Sjimharris } operation; 193230557Sjimharris 194230557Sjimharris} SCIF_SAS_DOMAIN_T; 195230557Sjimharris 196230557Sjimharrisvoid scif_sas_domain_construct( 197230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 198230557Sjimharris U8 domain_id, 199230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller 200230557Sjimharris); 201230557Sjimharris 202230557Sjimharrisvoid scif_sas_domain_terminate_requests( 203230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 204230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * fw_device, 205230557Sjimharris SCIF_SAS_REQUEST_T * fw_request, 206230557Sjimharris SCIF_SAS_TASK_REQUEST_T * fw_requestor 207230557Sjimharris); 208230557Sjimharris 209230557SjimharrisSCIF_SAS_REQUEST_T * scif_sas_domain_get_request_by_io_tag( 210230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 211230557Sjimharris U16 io_tag 212230557Sjimharris); 213230557Sjimharris 214230557Sjimharrisvoid scif_sas_domain_transition_to_stopped_state( 215230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 216230557Sjimharris); 217230557Sjimharris 218230557Sjimharrisvoid scif_sas_domain_initialize( 219230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 220230557Sjimharris); 221230557Sjimharris 222230557Sjimharrisvoid scif_sas_domain_remote_device_start_complete( 223230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 224230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * fw_device 225230557Sjimharris); 226230557Sjimharris 227230557SjimharrisBOOL scif_sas_domain_is_in_smp_activity( 228230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 229230557Sjimharris); 230230557Sjimharris 231230557SjimharrisSCIF_SAS_REMOTE_DEVICE_T * scif_sas_domain_get_device_by_containing_device( 232230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 233230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * containing_device, 234230557Sjimharris U8 expander_phy_id 235230557Sjimharris); 236230557Sjimharris 237230557SjimharrisSCIF_SAS_REMOTE_DEVICE_T * scif_sas_domain_find_device_in_spinup_hold( 238230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 239230557Sjimharris); 240230557Sjimharris 241230557SjimharrisSCIF_SAS_REMOTE_DEVICE_T * scif_sas_domain_find_device_has_scheduled_activity( 242230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 243230557Sjimharris U8 smp_activity 244230557Sjimharris); 245230557Sjimharris 246230557Sjimharrisvoid scif_sas_domain_start_smp_activity( 247230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 248230557Sjimharris); 249230557Sjimharris 250230557Sjimharrisvoid scif_sas_domain_remove_expander_device( 251230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 252230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * fw_device 253230557Sjimharris); 254230557Sjimharris 255230557Sjimharrisvoid scif_sas_domain_start_smp_discover( 256230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 257230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * top_expander 258230557Sjimharris); 259230557Sjimharris 260230557Sjimharrisvoid scif_sas_domain_continue_discover( 261230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 262230557Sjimharris); 263230557Sjimharris 264230557Sjimharrisvoid scif_sas_domain_finish_discover( 265230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 266230557Sjimharris); 267230557Sjimharris 268230557Sjimharrisvoid scif_sas_domain_transition_to_discovering_state( 269230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 270230557Sjimharris); 271230557Sjimharris 272230557Sjimharrisvoid scif_sas_domain_cancel_smp_activities( 273230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 274230557Sjimharris); 275230557Sjimharris 276230557SjimharrisU8 scif_sas_domain_get_smp_request_count( 277230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 278230557Sjimharris); 279230557Sjimharris 280230557Sjimharrisvoid scif_sas_domain_schedule_clear_affiliation( 281230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 282230557Sjimharris); 283230557Sjimharris 284230557Sjimharrisvoid scif_sas_domain_start_clear_affiliation( 285230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 286230557Sjimharris); 287230557Sjimharris 288230557Sjimharrisvoid scif_sas_domain_continue_clear_affiliation( 289230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 290230557Sjimharris); 291230557Sjimharris 292230557Sjimharrisvoid scif_sas_domain_release_resource( 293230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller, 294230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 295230557Sjimharris); 296230557Sjimharris 297230557SjimharrisSCIF_SAS_REMOTE_DEVICE_T * scif_sas_domain_find_next_ea_target_reset( 298230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain 299230557Sjimharris); 300230557Sjimharris 301230557Sjimharris#if !defined(DISABLE_WIDE_PORTED_TARGETS) 302230557Sjimharrisvoid scif_sas_domain_update_device_port_width( 303230557Sjimharris SCIF_SAS_DOMAIN_T * fw_domain, 304230557Sjimharris SCI_PORT_HANDLE_T port 305230557Sjimharris); 306230557Sjimharris#else //!defined(DISABLE_WIDE_PORTED_TARGETS) 307230557Sjimharris#define scif_sas_domain_update_device_port_width(domain, port) 308230557Sjimharris#endif //!defined(DISABLE_WIDE_PORTED_TARGETS) 309230557Sjimharris 310230557Sjimharris#ifdef SCI_LOGGING 311230557Sjimharrisvoid scif_sas_domain_initialize_state_logging( 312230557Sjimharris SCIF_SAS_DOMAIN_T *fw_domain 313230557Sjimharris); 314230557Sjimharris 315230557Sjimharrisvoid scif_sas_domain_deinitialize_state_logging( 316230557Sjimharris SCIF_SAS_DOMAIN_T *fw_domain 317230557Sjimharris); 318230557Sjimharris#else // SCI_LOGGING 319230557Sjimharris#define scif_sas_domain_initialize_state_logging(x) 320230557Sjimharris#define scif_sas_domain_deinitialize_state_logging(x) 321230557Sjimharris#endif // SCI_LOGGING 322230557Sjimharris 323230557Sjimharris#ifdef __cplusplus 324230557Sjimharris} 325230557Sjimharris#endif // __cplusplus 326230557Sjimharris 327230557Sjimharris#endif // _SCIF_SAS_DOMAIN_H_ 328230557Sjimharris 329