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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
54 #ifndef _SATI_TYPES_H_
55 #define _SATI_TYPES_H_
59 * @brief This file contains various type definitions to be utilized with
60 * SCSI to ATA Translation Implementation.
63 #include <dev/isci/types.h>
68 * @brief This enumeration defines the possible return values from the
69 * SATI translation methods.
71 typedef enum _SATI_STATUS
74 * This indicates that the translation was supported and occurred
80 * This indicates that the translation was supported and occurred
82 * Additionally, this indicates the translation actually already
83 * translated the scatter gather list elements appropriately as
86 SATI_SUCCESS_SGL_TRANSLATED,
89 * This indicates that the translation was supported, occurred without
90 * error, and no additional translation is necessary. This is done in
91 * conditions where the SCSI command doesn't require any interaction with
97 * This indicated everything SATI_COMPLETE does in addition to the response data
98 not using all the memory allocated by the OS.
100 SATI_COMPLETE_IO_DONE_EARLY,
103 * This indicates that translator sequence has finished some specific
104 * command in the sequence, but additional commands are necessary.
106 SATI_SEQUENCE_INCOMPLETE,
109 * This indicates a general failure has occurred for which no further
110 * specification information is available.
115 * This indicates that the result of the IO request indicates a
116 * failure. The caller should reference the corresponding response
117 * data for further details.
119 SATI_FAILURE_CHECK_RESPONSE_DATA,
122 * This status indicates that the supplied sequence type doesn't map
123 * to an existing definition.
125 SATI_FAILURE_INVALID_SEQUENCE_TYPE,
128 * This status indicates that the supplied sequence state doesn't match
129 * the operation being requested by the user.
131 SATI_FAILURE_INVALID_STATE
135 #if ( !defined(DISABLE_SATI_MODE_SENSE) \
136 || !defined(DISABLE_SATI_MODE_SELECT) \
137 || !defined(DISABLE_SATI_REQUEST_SENSE) ) \
139 #if !defined(ENABLE_SATI_MODE_PAGES)
141 * This macro enables the common mode page data structures and code.
142 * Currently, MODE SENSE, MODE SELECT, and REQUEST SENSE all make
143 * reference to this common code. As a result, enable the common
144 * mode page code if any of these 3 are being translated.
146 #define ENABLE_SATI_MODE_PAGES
147 #endif // !defined(ENABLE_SATI_MODE_PAGES)
149 #endif // MODE_SENSE/SELECT/REQUEST_SENSE
151 #endif // _SATI_TYPES_H_