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_USER_PARAMETERS_H_ 55230557Sjimharris#define _SCIF_SAS_USER_PARAMETERS_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the interface methods that can be called 61230557Sjimharris * by an SCIF user on a SCIF_SAS_USER_PARAMETERS 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 * @struct SCIF_SAS_USER_PARAMETERS 75230557Sjimharris * 76230557Sjimharris * @brief This structure delineates the various user parameters that can be 77230557Sjimharris * changed by the framework user. 78230557Sjimharris */ 79230557Sjimharristypedef struct SCIF_SAS_USER_PARAMETERS 80230557Sjimharris{ 81230557Sjimharris /** 82230557Sjimharris * This field indicates if the user would like to have the SATA NCQ 83230557Sjimharris * feature enabled for all remote devices. 84230557Sjimharris */ 85230557Sjimharris BOOL is_sata_ncq_enabled; 86230557Sjimharris 87230557Sjimharris /** 88230557Sjimharris * This field indicates if the user would like to have the SATA Automatic 89230557Sjimharris * Standby Timer feature enabled for all remote devices. 90230557Sjimharris */ 91230557Sjimharris BOOL is_sata_standby_timer_enabled; 92230557Sjimharris 93230557Sjimharris /** 94230557Sjimharris * This field indicates if the user would like to have the SATA Non-zero 95230557Sjimharris * Buffer Offset feature enabled for all remote devices. 96230557Sjimharris */ 97230557Sjimharris BOOL is_non_zero_buffer_offsets_enabled; 98230557Sjimharris 99230557Sjimharris /** 100230557Sjimharris * This field indicates if the user would like to clear affiliation for EA 101230557Sjimharris * SATA devices during the controller stop process. 102230557Sjimharris */ 103230557Sjimharris BOOL clear_affiliation_during_controller_stop; 104230557Sjimharris 105230557Sjimharris /** 106230557Sjimharris * This field indicates the user's desired NCQ depth for all remote 107230557Sjimharris * devices. The maximum legal value for this field is 32. 108230557Sjimharris */ 109230557Sjimharris U16 max_ncq_depth; 110230557Sjimharris 111230557Sjimharris /** 112230557Sjimharris * This field indicates the type of reset to be applied to all remote 113230557Sjimharris * devices the first time they are discovered. 114230557Sjimharris */ 115230557Sjimharris SCI_SAS_TASK_MGMT_FUNCTION_T reset_type; 116230557Sjimharris 117230557Sjimharris /** 118230557Sjimharris * This field indicates the os/user recommends ignoring fua in translation 119230557Sjimharris * for perfromance reasons. 120230557Sjimharris */ 121230557Sjimharris BOOL ignore_fua; 122230557Sjimharris 123230557Sjimharris} SCIF_SAS_USER_PARAMETERS_T; 124230557Sjimharris 125230557Sjimharris/** 126230557Sjimharris * @union SCIF_USER_PARAMETERS 127230557Sjimharris * @brief This structure/union specifies the various different user 128230557Sjimharris * parameter sets available. Each type is specific to a 129230557Sjimharris * Serial Attached SCSI implementation of the framework. 130230557Sjimharris * 131230557Sjimharris */ 132230557Sjimharristypedef union SCIF_USER_PARAMETERS 133230557Sjimharris{ 134230557Sjimharris SCIF_SAS_USER_PARAMETERS_T sas; 135230557Sjimharris 136230557Sjimharris} SCIF_USER_PARAMETERS_T; 137230557Sjimharris 138230557Sjimharris/** 139230557Sjimharris * @brief This method allows the user to attempt to change the user 140230557Sjimharris * parameters utilized by the controller. 141230557Sjimharris * 142230557Sjimharris * @param[in] controller This parameter specifies the controller on which 143230557Sjimharris * to set the user parameters. 144230557Sjimharris * @param[in] user_parameters This parameter specifies the USER_PARAMETERS 145230557Sjimharris * object containing the potential new values. 146230557Sjimharris * 147230557Sjimharris * @return Indicate if the update of the user parameters was successful. 148230557Sjimharris * @retval SCI_SUCCESS This value is returned if the operation succeeded. 149230557Sjimharris * @retval SCI_FAILURE_INVALID_STATE This value is returned if the attempt 150230557Sjimharris * to change the user parameter failed, because changing one of 151230557Sjimharris * the parameters is not currently allowed. 152230557Sjimharris * @retval SCI_FAILURE_INVALID_PARAMETER_VALUE This value is returned if the 153230557Sjimharris * user supplied an invalid reset_type, ncq depth, etc. 154230557Sjimharris */ 155230557SjimharrisSCI_STATUS scif_user_parameters_set( 156230557Sjimharris SCI_CONTROLLER_HANDLE_T controller, 157230557Sjimharris SCIF_USER_PARAMETERS_T * user_parameters 158230557Sjimharris); 159230557Sjimharris 160230557Sjimharris/** 161230557Sjimharris * @brief This method allows the user to retrieve the user parameters 162230557Sjimharris * utilized by the controller. 163230557Sjimharris * 164230557Sjimharris * @param[in] controller This parameter specifies the controller on which 165230557Sjimharris * to set the user parameters. 166230557Sjimharris * @param[in] user_parameters This parameter specifies the USER_PARAMETERS 167230557Sjimharris * object into which the framework shall save it's parameters. 168230557Sjimharris * 169230557Sjimharris * @return none 170230557Sjimharris */ 171230557Sjimharrisvoid scif_user_parameters_get( 172230557Sjimharris SCI_CONTROLLER_HANDLE_T controller, 173230557Sjimharris SCIF_USER_PARAMETERS_T * user_parameters 174230557Sjimharris); 175230557Sjimharris 176230557Sjimharris#ifdef __cplusplus 177230557Sjimharris} 178230557Sjimharris#endif // __cplusplus 179230557Sjimharris 180230557Sjimharris#endif // _SCIF_SAS_USER_PARAMETERS_H_ 181230557Sjimharris 182