2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
56 #ifndef _SATI_TYPES_H_
57 #define _SATI_TYPES_H_
61 * @brief This file contains various type definitions to be utilized with
62 * SCSI to ATA Translation Implementation.
65 #include <dev/isci/types.h>
70 * @brief This enumeration defines the possible return values from the
71 * SATI translation methods.
73 typedef enum _SATI_STATUS
76 * This indicates that the translation was supported and occurred
82 * This indicates that the translation was supported and occurred
84 * Additionally, this indicates the translation actually already
85 * translated the scatter gather list elements appropriately as
88 SATI_SUCCESS_SGL_TRANSLATED,
91 * This indicates that the translation was supported, occurred without
92 * error, and no additional translation is necessary. This is done in
93 * conditions where the SCSI command doesn't require any interaction with
99 * This indicated everything SATI_COMPLETE does in addition to the response data
100 not using all the memory allocated by the OS.
102 SATI_COMPLETE_IO_DONE_EARLY,
105 * This indicates that translator sequence has finished some specific
106 * command in the sequence, but additional commands are necessary.
108 SATI_SEQUENCE_INCOMPLETE,
111 * This indicates a general failure has occurred for which no further
112 * specification information is available.
117 * This indicates that the result of the IO request indicates a
118 * failure. The caller should reference the corresponding response
119 * data for further details.
121 SATI_FAILURE_CHECK_RESPONSE_DATA,
124 * This status indicates that the supplied sequence type doesn't map
125 * to an existing definition.
127 SATI_FAILURE_INVALID_SEQUENCE_TYPE,
130 * This status indicates that the supplied sequence state doesn't match
131 * the operation being requested by the user.
133 SATI_FAILURE_INVALID_STATE
137 #if ( !defined(DISABLE_SATI_MODE_SENSE) \
138 || !defined(DISABLE_SATI_MODE_SELECT) \
139 || !defined(DISABLE_SATI_REQUEST_SENSE) ) \
141 #if !defined(ENABLE_SATI_MODE_PAGES)
143 * This macro enables the common mode page data structures and code.
144 * Currently, MODE SENSE, MODE SELECT, and REQUEST SENSE all make
145 * reference to this common code. As a result, enable the common
146 * mode page code if any of these 3 are being translated.
148 #define ENABLE_SATI_MODE_PAGES
149 #endif // !defined(ENABLE_SATI_MODE_PAGES)
151 #endif // MODE_SENSE/SELECT/REQUEST_SENSE
153 #endif // _SATI_TYPES_H_