drivers/scsi/isci/core/scu_viit_data.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 _SCU_VIIT_DATA_HEADER_
  57 #define _SCU_VIIT_DATA_HEADER_
  58
  59 /**
  60  * This file contains the constants and structures for the SCU hardware VIIT
  61  *    table entries.
  62  *
  63  *
  64  */
  65
  66
  67 #define SCU_VIIT_ENTRY_ID_MASK         (0xC0000000)
  68 #define SCU_VIIT_ENTRY_ID_SHIFT        (30)
  69
  70 #define SCU_VIIT_ENTRY_FUNCTION_MASK   (0x0FF00000)
  71 #define SCU_VIIT_ENTRY_FUNCTION_SHIFT  (20)
  72
  73 #define SCU_VIIT_ENTRY_IPPTMODE_MASK   (0x0001F800)
  74 #define SCU_VIIT_ENTRY_IPPTMODE_SHIFT  (12)
  75
  76 #define SCU_VIIT_ENTRY_LPVIE_MASK      (0x00000F00)
  77 #define SCU_VIIT_ENTRY_LPVIE_SHIFT     (8)
  78
  79 #define SCU_VIIT_ENTRY_STATUS_MASK     (0x000000FF)
  80 #define SCU_VIIT_ENTRY_STATUS_SHIFT    (0)
  81
  82 #define SCU_VIIT_ENTRY_ID_INVALID   (0 << SCU_VIIT_ENTRY_ID_SHIFT)
  83 #define SCU_VIIT_ENTRY_ID_VIIT      (1 << SCU_VIIT_ENTRY_ID_SHIFT)
  84 #define SCU_VIIT_ENTRY_ID_IIT       (2 << SCU_VIIT_ENTRY_ID_SHIFT)
  85 #define SCU_VIIT_ENTRY_ID_VIRT_EXP  (3 << SCU_VIIT_ENTRY_ID_SHIFT)
  86
  87 #define SCU_VIIT_IPPT_SSP_INITIATOR (0x01 << SCU_VIIT_ENTRY_IPPTMODE_SHIFT)
  88 #define SCU_VIIT_IPPT_SMP_INITIATOR (0x02 << SCU_VIIT_ENTRY_IPPTMODE_SHIFT)
  89 #define SCU_VIIT_IPPT_STP_INITIATOR (0x04 << SCU_VIIT_ENTRY_IPPTMODE_SHIFT)
  90 #define SCU_VIIT_IPPT_INITIATOR     \
  91         (\
  92                 SCU_VIIT_IPPT_SSP_INITIATOR  \
  93                 | SCU_VIIT_IPPT_SMP_INITIATOR  \
  94                 | SCU_VIIT_IPPT_STP_INITIATOR  \
  95         )
  96
  97 #define SCU_VIIT_STATUS_RNC_VALID      (0x01 << SCU_VIIT_ENTRY_STATUS_SHIFT)
  98 #define SCU_VIIT_STATUS_ADDRESS_VALID  (0x02 << SCU_VIIT_ENTRY_STATUS_SHIFT)
  99 #define SCU_VIIT_STATUS_RNI_VALID      (0x04 << SCU_VIIT_ENTRY_STATUS_SHIFT)
 100 #define SCU_VIIT_STATUS_ALL_VALID      \
 101         (\
 102                 SCU_VIIT_STATUS_RNC_VALID       \
 103                 | SCU_VIIT_STATUS_ADDRESS_VALID   \
 104                 | SCU_VIIT_STATUS_RNI_VALID       \
 105         )
 106
 107 #define SCU_VIIT_IPPT_SMP_TARGET    (0x10 << SCU_VIIT_ENTRY_IPPTMODE_SHIFT)
 108
 109 /**
 110  * struct scu_viit_entry - This is the SCU Virtual Initiator Table Entry
 111  *
 112  *
 113  */
 114 struct scu_viit_entry {
 115         /**
 116          * This must be encoded as to the type of initiator that is being constructed
 117          * for this port.
 118          */
 119         u32 status;
 120
 121         /**
 122          * Virtual initiator high SAS Address
 123          */
 124         u32 initiator_sas_address_hi;
 125
 126         /**
 127          * Virtual initiator low SAS Address
 128          */
 129         u32 initiator_sas_address_lo;
 130
 131         /**
 132          * This must be 0
 133          */
 134         u32 reserved;
 135
 136 };
 137
 138
 139 /* IIT Status Defines */
 140 #define SCU_IIT_ENTRY_ID_MASK                (0xC0000000)
 141 #define SCU_IIT_ENTRY_ID_SHIFT               (30)
 142
 143 #define SCU_IIT_ENTRY_STATUS_UPDATE_MASK     (0x20000000)
 144 #define SCU_IIT_ENTRY_STATUS_UPDATE_SHIFT    (29)
 145
 146 #define SCU_IIT_ENTRY_LPI_MASK               (0x00000F00)
 147 #define SCU_IIT_ENTRY_LPI_SHIFT              (8)
 148
 149 #define SCU_IIT_ENTRY_STATUS_MASK            (0x000000FF)
 150 #define SCU_IIT_ENTRY_STATUS_SHIFT           (0)
 151
 152 /* IIT Remote Initiator Defines */
 153 #define SCU_IIT_ENTRY_REMOTE_TAG_MASK  (0x0000FFFF)
 154 #define SCU_IIT_ENTRY_REMOTE_TAG_SHIFT (0)
 155
 156 #define SCU_IIT_ENTRY_REMOTE_RNC_MASK  (0x0FFF0000)
 157 #define SCU_IIT_ENTRY_REMOTE_RNC_SHIFT (16)
 158
 159 #define SCU_IIT_ENTRY_ID_INVALID   (0 << SCU_IIT_ENTRY_ID_SHIFT)
 160 #define SCU_IIT_ENTRY_ID_VIIT      (1 << SCU_IIT_ENTRY_ID_SHIFT)
 161 #define SCU_IIT_ENTRY_ID_IIT       (2 << SCU_IIT_ENTRY_ID_SHIFT)
 162 #define SCU_IIT_ENTRY_ID_VIRT_EXP  (3 << SCU_IIT_ENTRY_ID_SHIFT)
 163
 164 /**
 165  * struct scu_iit_entry - This will be implemented later when we support
 166  *    virtual functions
 167  *
 168  *
 169  */
 170 struct scu_iit_entry {
 171         u32 status;
 172         u32 remote_initiator_sas_address_hi;
 173         u32 remote_initiator_sas_address_lo;
 174         u32 remote_initiator;
 175
 176 };
 177
 178 #endif /* _SCU_VIIT_DATA_HEADER_ */