xref: /freebsd/sys/dev/isci/scil/scif_sas_stp_remote_device.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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  * $FreeBSD$
55  */
56 #ifndef _SCIF_SAS_STP_REMOTE_DEVICE_H_
57 #define _SCIF_SAS_STP_REMOTE_DEVICE_H_
58 
59 /**
60  * @file
61  *
62  * @brief This file contains the protected interface structures, constants,
63  *        and methods for the SCIF_SAS_STP_REMOTE_DEVICE object.
64  */
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif // __cplusplus
69 
70 #include <dev/isci/scil/sati_device.h>
71 
72 #define SCIF_SAS_INVALID_NCQ_TAG 0xFF
73 
74 /**
75  * @struct SCIF_SAS_STP_REMOTE_DEVICE
76  *
77  * @brief The SCI SAS STP Framework remote device object abstracts the SAS
78  *        SATA/STP remote device level behavior for the framework component.
79  */
80 typedef struct SCIF_SAS_STP_REMOTE_DEVICE
81 {
82    /**
83     * This field contains all of the data utilized by the SCSI-to-ATA
84     * Translation Implementation (SATI).
85     */
86    SATI_DEVICE_T  sati_device;
87 
88    /**
89     * This field contains a list of free NCQ tags available for use in
90     * SATA Native Command Queuing (NCQ) requests.
91     */
92    U32 s_active;
93 
94 } SCIF_SAS_STP_REMOTE_DEVICE_T;
95 
96 struct SCIF_SAS_REMOTE_DEVICE;
97 void scif_sas_stp_remote_device_construct(
98    struct SCIF_SAS_REMOTE_DEVICE * fw_device
99 );
100 
101 U8 scif_sas_stp_remote_device_allocate_ncq_tag(
102    struct SCIF_SAS_REMOTE_DEVICE * fw_device
103 );
104 
105 void scif_sas_stp_remote_device_free_ncq_tag(
106    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
107    U8                              ncq_tag
108 );
109 
110 struct SCIF_SAS_REQUEST *
111 scif_sas_stp_remote_device_get_request_by_ncq_tag(
112    struct SCIF_SAS_REMOTE_DEVICE * fw_device,
113    U8                              ncq_tag
114 );
115 
116 #ifdef __cplusplus
117 }
118 #endif // __cplusplus
119 
120 #endif // _SCIF_SAS_STP_REMOTE_DEVICE_H_
121 
122