1/*-
2 * This file is provided under a dual BSD/GPLv2 license.  When using or
3 * redistributing this file, you may do so under either license.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
23 *
24 * BSD LICENSE
25 *
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
28 *
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
32 *
33 *   * Redistributions of source code must retain the above copyright
34 *     notice, this list of conditions and the following disclaimer.
35 *   * Redistributions in binary form must reproduce the above copyright
36 *     notice, this list of conditions and the following disclaimer in
37 *     the documentation and/or other materials provided with the
38 *     distribution.
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 *
52 * $FreeBSD$
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
65extern "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 */
78typedef 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
94struct SCIF_SAS_REMOTE_DEVICE;
95void scif_sas_stp_remote_device_construct(
96   struct SCIF_SAS_REMOTE_DEVICE * fw_device
97);
98
99U8 scif_sas_stp_remote_device_allocate_ncq_tag(
100   struct SCIF_SAS_REMOTE_DEVICE * fw_device
101);
102
103void scif_sas_stp_remote_device_free_ncq_tag(
104   struct SCIF_SAS_REMOTE_DEVICE * fw_device,
105   U8                              ncq_tag
106);
107
108struct SCIF_SAS_REQUEST *
109scif_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