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_DOMAIN_H_ 55230557Sjimharris#define _SCIF_DOMAIN_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the interface methods that can be called 61230557Sjimharris * by an SCI Framework user on the SAS/SATA domain object. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/sci_types.h> 69230557Sjimharris#include <dev/isci/scil/sci_status.h> 70230557Sjimharris#include <dev/isci/scil/intel_sas.h> 71230557Sjimharris 72230557Sjimharris 73230557Sjimharris/** 74230557Sjimharris * @brief This method enables the framework user to find the SCI Core Port 75230557Sjimharris * object through which the supplied domain is accessed. 76230557Sjimharris * 77230557Sjimharris * @param[in] domain This parameter specifies the framework domain object 78230557Sjimharris * for which to return the corresponding SCI Core port object. 79230557Sjimharris * 80230557Sjimharris * @return Return a handle to the SCI Core port through which the supplied 81230557Sjimharris * domain is accessed. 82230557Sjimharris * @retval SCI_INVALID_HANDLE This value is returned if the core port 83230557Sjimharris * object can not be retrieved. 84230557Sjimharris */ 85230557SjimharrisSCI_PORT_HANDLE_T scif_domain_get_scic_port_handle( 86230557Sjimharris SCI_DOMAIN_HANDLE_T domain 87230557Sjimharris); 88230557Sjimharris 89230557Sjimharris/** 90230557Sjimharris * @brief This method will find and retreive the device associated with the 91230557Sjimharris * supplied SAS address if such a device exists. 92230557Sjimharris * 93230557Sjimharris * @param[in] domain This parameter specifies the framework domain object 94230557Sjimharris * on which to discover devices. 95230557Sjimharris * @param[in] sas_address This parameter specifies the SAS address of the 96230557Sjimharris * object to locate in this domain. 97230557Sjimharris * 98230557Sjimharris * @return Indicate if the device was successfully found in the domain. 99230557Sjimharris * @retval SCI_INVALID_HANDLE This value is returned if the device is not 100230557Sjimharris * found in the domain. 101230557Sjimharris * @retval All other values indicate a valid remote device being found. 102230557Sjimharris */ 103230557SjimharrisSCI_REMOTE_DEVICE_HANDLE_T scif_domain_get_device_by_sas_address( 104230557Sjimharris SCI_DOMAIN_HANDLE_T domain, 105230557Sjimharris SCI_SAS_ADDRESS_T * sas_address 106230557Sjimharris); 107230557Sjimharris 108230557Sjimharris/** 109230557Sjimharris * @brief This method will attempt to discover the supplied domain. 110230557Sjimharris * 111230557Sjimharris * @warning This method must be synchronized with the controller completion 112230557Sjimharris * handler (see scic_controller_get_handler_methods()). The user 113230557Sjimharris * may call this method from within the completion handler in which 114230557Sjimharris * case, no synchronization is necessary. 115230557Sjimharris * 116230557Sjimharris * @note 117230557Sjimharris * - IO requests from the OS driver are held off until discovery 118230557Sjimharris * of the domain is complete. 119230557Sjimharris * - Discovery may perform SSP or STP IO requests to configure 120230557Sjimharris * remote devices prior to informing the SCIF User of their 121230557Sjimharris * existence via the remote_device_ready user callback. 122230557Sjimharris * 123230557Sjimharris * @param[in] domain This parameter specifies the framework domain object 124230557Sjimharris * on which to discover devices. 125230557Sjimharris * @param[in] discover_timeout This parameter specifies the number of 126230557Sjimharris * milliseconds in which the domain discovery operation should 127230557Sjimharris * complete. 128230557Sjimharris * @param[in] device_timeout This parameter specifies the number of 129230557Sjimharris * milliseconds in which the device configuration and/or reset 130230557Sjimharris * operations should complete. Logically, the device_timeout 131230557Sjimharris * parameter should be shorter then the domain_timeout value. 132230557Sjimharris * Especially considering the domain could be made up of "n" 133230557Sjimharris * different devices. 134230557Sjimharris * 135230557Sjimharris * @return Indicate if the discover operation started successfully. 136230557Sjimharris * @retval SCI_SUCCESS This value is returned if the discover operation 137230557Sjimharris * started successfully. 138230557Sjimharris * @retval SCI_WARNING_TIMER_CONFLICT This value is returned if the SCI 139230557Sjimharris * implementation doesn't support the desired timeout amounts or if 140230557Sjimharris * the desired timeout amounts conflict in some manner. 141230557Sjimharris */ 142230557SjimharrisSCI_STATUS scif_domain_discover( 143230557Sjimharris SCI_DOMAIN_HANDLE_T domain, 144230557Sjimharris U32 discover_timeout, 145230557Sjimharris U32 device_timeout 146230557Sjimharris); 147230557Sjimharris 148230557Sjimharris#if !defined(DISABLE_SCI_ITERATORS) 149230557Sjimharris/** 150230557Sjimharris * @brief This method gets an iterator for the list of remote devices in the 151230557Sjimharris * specified domain. 152230557Sjimharris * 153230557Sjimharris * @param[in] domain: This parameter specifies the framework domain handle 154230557Sjimharris * @param[in] iterator_buffer: This parameters specifies the memory buffer that 155230557Sjimharris * will be used to construct the iterator. 156230557Sjimharris * 157230557Sjimharris * @retval Handle to the remote device list iterator. 158230557Sjimharris */ 159230557SjimharrisSCI_ITERATOR_HANDLE_T scif_domain_get_remote_device_iterator( 160230557Sjimharris SCI_DOMAIN_HANDLE_T domain, 161230557Sjimharris void * iterator_buffer 162230557Sjimharris); 163230557Sjimharris#else // !defined(DISABLE_SCI_ITERATORS) 164230557Sjimharris#define scif_domain_get_remote_device_iterator(the_domain, the_buffer) \ 165230557Sjimharris SCI_INVALID_HANDLE 166230557Sjimharris#endif // !defined(DISABLE_SCI_ITERATORS) 167230557Sjimharris 168230557Sjimharris/** 169230557Sjimharris * @brief This method simply returns a suggest timeout value for discovery. 170230557Sjimharris * 171230557Sjimharris * @param[in] domain The handle to the domain whose discover activity is to 172230557Sjimharris * be started. 173230557Sjimharris * 174230557Sjimharris * @return The suggested timeout value for domain discover in milli-seconds. 175230557Sjimharris */ 176230557SjimharrisU32 scif_domain_get_suggested_discover_timeout( 177230557Sjimharris SCI_DOMAIN_HANDLE_T domain 178230557Sjimharris); 179230557Sjimharris 180230557Sjimharris#ifdef __cplusplus 181230557Sjimharris} 182230557Sjimharris#endif // __cplusplus 183230557Sjimharris 184230557Sjimharris#endif // _SCIF_DOMAIN_H_ 185230557Sjimharris 186