1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * This file is provided under a dual BSD/GPLv2 license. When using or 5 * redistributing this file, you may do so under either license. 6 * 7 * GPL LICENSE SUMMARY 8 * 9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23 * The full GNU General Public License is included in this distribution 24 * in the file called LICENSE.GPL. 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 35 * * Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * * Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in 39 * the documentation and/or other materials provided with the 40 * distribution. 41 * 42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53 */ 54 #ifndef _SCIF_SAS_STP_REMOTE_DEVICE_H_ 55 #define _SCIF_SAS_STP_REMOTE_DEVICE_H_ 56 57 /** 58 * @file 59 * 60 * @brief This file contains the protected interface structures, constants, 61 * and methods for the SCIF_SAS_STP_REMOTE_DEVICE object. 62 */ 63 64 #ifdef __cplusplus 65 extern "C" { 66 #endif // __cplusplus 67 68 #include <dev/isci/scil/sati_device.h> 69 70 #define SCIF_SAS_INVALID_NCQ_TAG 0xFF 71 72 /** 73 * @struct SCIF_SAS_STP_REMOTE_DEVICE 74 * 75 * @brief The SCI SAS STP Framework remote device object abstracts the SAS 76 * SATA/STP remote device level behavior for the framework component. 77 */ 78 typedef struct SCIF_SAS_STP_REMOTE_DEVICE 79 { 80 /** 81 * This field contains all of the data utilized by the SCSI-to-ATA 82 * Translation Implementation (SATI). 83 */ 84 SATI_DEVICE_T sati_device; 85 86 /** 87 * This field contains a list of free NCQ tags available for use in 88 * SATA Native Command Queuing (NCQ) requests. 89 */ 90 U32 s_active; 91 92 } SCIF_SAS_STP_REMOTE_DEVICE_T; 93 94 struct SCIF_SAS_REMOTE_DEVICE; 95 void scif_sas_stp_remote_device_construct( 96 struct SCIF_SAS_REMOTE_DEVICE * fw_device 97 ); 98 99 U8 scif_sas_stp_remote_device_allocate_ncq_tag( 100 struct SCIF_SAS_REMOTE_DEVICE * fw_device 101 ); 102 103 void scif_sas_stp_remote_device_free_ncq_tag( 104 struct SCIF_SAS_REMOTE_DEVICE * fw_device, 105 U8 ncq_tag 106 ); 107 108 struct SCIF_SAS_REQUEST * 109 scif_sas_stp_remote_device_get_request_by_ncq_tag( 110 struct SCIF_SAS_REMOTE_DEVICE * fw_device, 111 U8 ncq_tag 112 ); 113 114 #ifdef __cplusplus 115 } 116 #endif // __cplusplus 117 118 #endif // _SCIF_SAS_STP_REMOTE_DEVICE_H_ 119 120