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