drivers/scsi/isci/core/sati_types.h

   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  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #ifndef _SATI_TYPES_H_
  57 #define _SATI_TYPES_H_
  58
  59 /**
  60  * This file contains various type definitions to be utilized with SCSI to ATA
  61  *    Translation Implementation.
  62  *
  63  *
  64  */
  65
  66 /**
  67  * enum _SATI_STATUS - This enumeration defines the possible return values from
  68  *    the SATI translation methods.
  69  *
  70  *
  71  */
  72 enum sati_status {
  73         /**
  74          * This indicates that the translation was supported and occurred
  75          * without error.
  76          */
  77         SATI_SUCCESS,
  78
  79         /**
  80          * This indicates that the translation was supported, occurred without
  81          * error, and no additional translation is necessary.  This is done in
  82          * conditions where the SCSI command doesn't require any interaction with
  83          * the remote device.
  84          */
  85         SATI_COMPLETE,
  86
  87         /**
  88          * This indicated everything SATI_COMPLETE does in addition to the response data
  89          * not using all the memory allocated by the OS.
  90          */
  91         SATI_COMPLETE_IO_DONE_EARLY,
  92
  93         /**
  94          * This indicates that translator sequence has finished some specific
  95          * command in the sequence, but additional commands are necessary.
  96          */
  97         SATI_SEQUENCE_INCOMPLETE,
  98
  99         /**
 100          * This indicates a general failure has occurred for which no further
 101          * specification information is available.
 102          */
 103         SATI_FAILURE,
 104
 105         /**
 106          * This indicates that the result of the IO request indicates a
 107          * failure.  The caller should reference the corresponding response
 108          * data for further details.
 109          */
 110         SATI_FAILURE_CHECK_RESPONSE_DATA,
 111
 112         /**
 113          * This status indicates that the supplied sequence type doesn't map
 114          * to an existing definition.
 115          */
 116         SATI_FAILURE_INVALID_SEQUENCE_TYPE,
 117
 118         /**
 119          * This status indicates that the supplied sequence state doesn't match
 120          * the operation being requested by the user.
 121          */
 122         SATI_FAILURE_INVALID_STATE
 123
 124 };
 125
 126 #if (!defined(DISABLE_SATI_MODE_SENSE)      \
 127         || !defined(DISABLE_SATI_MODE_SELECT)     \
 128         || !defined(DISABLE_SATI_REQUEST_SENSE)) \
 129
 130 #if !defined(ENABLE_SATI_MODE_PAGES)
 131 /**
 132  *
 133  *
 134  * This macro enables the common mode page data structures and code. Currently,
 135  * MODE SENSE, MODE SELECT, and REQUEST SENSE all make reference to this common
 136  * code.  As a result, enable the common mode page code if any of these 3 are
 137  * being translated.
 138  */
 139 #define ENABLE_SATI_MODE_PAGES
 140 #endif  /* !defined(ENABLE_SATI_MODE_PAGES) */
 141
 142 #endif  /* MODE_SENSE/SELECT/REQUEST_SENSE */
 143
 144 #endif  /* _SATI_TYPES_H_ */
 145