drivers/scsi/isci/core/scic_phy.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 _SCIC_PHY_H_
  57 #define _SCIC_PHY_H_
  58
  59 /**
  60  * This file contains all of the interface methods that can be called by an
  61  *    SCIC user on a phy (SAS or SATA) object.
  62  *
  63  *
  64  */
  65
  66
  67 #include <scsi/sas.h>
  68 #include <scsi/libsas.h>
  69
  70 struct scic_sds_phy;
  71 struct scic_sds_port;
  72
  73
  74 enum sas_linkrate sci_phy_linkrate(struct scic_sds_phy *sci_phy);
  75
  76 struct scic_phy_cap {
  77         union {
  78                 struct {
  79                         /*
  80                          * The SAS specification indicates the start bit shall
  81                          * always be set to
  82                          * 1.  This implementation will have the start bit set
  83                          * to 0 if the PHY CAPABILITIES were either not
  84                          * received or speed negotiation failed.
  85                          */
  86                         u8 start:1;
  87                         u8 tx_ssc_type:1;
  88                         u8 res1:2;
  89                         u8 req_logical_linkrate:4;
  90
  91                         u32 gen1_no_ssc:1;
  92                         u32 gen1_ssc:1;
  93                         u32 gen2_no_ssc:1;
  94                         u32 gen2_ssc:1;
  95                         u32 gen3_no_ssc:1;
  96                         u32 gen3_ssc:1;
  97                         u32 res2:17;
  98                         u32 parity:1;
  99                 };
 100                 u32 all;
 101         };
 102 }  __packed;
 103
 104 /* this data structure reflects the link layer transmit identification reg */
 105 struct scic_phy_proto {
 106         union {
 107                 struct {
 108                         u16 _r_a:1;
 109                         u16 smp_iport:1;
 110                         u16 stp_iport:1;
 111                         u16 ssp_iport:1;
 112                         u16 _r_b:4;
 113                         u16 _r_c:1;
 114                         u16 smp_tport:1;
 115                         u16 stp_tport:1;
 116                         u16 ssp_tport:1;
 117                         u16 _r_d:4;
 118                 };
 119                 u16 all;
 120         };
 121 } __packed;
 122
 123
 124 /**
 125  * struct scic_phy_properties - This structure defines the properties common to
 126  *    all phys that can be retrieved.
 127  *
 128  *
 129  */
 130 struct scic_phy_properties {
 131         /**
 132          * This field specifies the port that currently contains the
 133          * supplied phy.  This field may be set to NULL
 134          * if the phy is not currently contained in a port.
 135          */
 136         struct scic_sds_port *owning_port;
 137
 138         /**
 139          * This field specifies the link rate at which the phy is
 140          * currently operating.
 141          */
 142         enum sas_linkrate negotiated_link_rate;
 143
 144         /**
 145          * This field specifies the index of the phy in relation to other
 146          * phys within the controller.  This index is zero relative.
 147          */
 148         u8 index;
 149 };
 150
 151 /**
 152  * struct scic_sas_phy_properties - This structure defines the properties,
 153  *    specific to a SAS phy, that can be retrieved.
 154  *
 155  *
 156  */
 157 struct scic_sas_phy_properties {
 158         /**
 159          * This field delineates the Identify Address Frame received
 160          * from the remote end point.
 161          */
 162         struct sas_identify_frame rcvd_iaf;
 163
 164         /**
 165          * This field delineates the Phy capabilities structure received
 166          * from the remote end point.
 167          */
 168         struct scic_phy_cap rcvd_cap;
 169
 170 };
 171
 172 /**
 173  * struct scic_sata_phy_properties - This structure defines the properties,
 174  *    specific to a SATA phy, that can be retrieved.
 175  *
 176  *
 177  */
 178 struct scic_sata_phy_properties {
 179         /**
 180          * This field delineates the signature FIS received from the
 181          * attached target.
 182          */
 183         struct dev_to_host_fis signature_fis;
 184
 185         /**
 186          * This field specifies to the user if a port selector is connected
 187          * on the specified phy.
 188          */
 189         bool is_port_selector_present;
 190
 191 };
 192
 193 /**
 194  * enum scic_phy_counter_id - This enumeration depicts the various pieces of
 195  *    optional information that can be retrieved for a specific phy.
 196  *
 197  *
 198  */
 199 enum scic_phy_counter_id {
 200         /**
 201          * This PHY information field tracks the number of frames received.
 202          */
 203         SCIC_PHY_COUNTER_RECEIVED_FRAME,
 204
 205         /**
 206          * This PHY information field tracks the number of frames transmitted.
 207          */
 208         SCIC_PHY_COUNTER_TRANSMITTED_FRAME,
 209
 210         /**
 211          * This PHY information field tracks the number of DWORDs received.
 212          */
 213         SCIC_PHY_COUNTER_RECEIVED_FRAME_WORD,
 214
 215         /**
 216          * This PHY information field tracks the number of DWORDs transmitted.
 217          */
 218         SCIC_PHY_COUNTER_TRANSMITTED_FRAME_DWORD,
 219
 220         /**
 221          * This PHY information field tracks the number of times DWORD
 222          * synchronization was lost.
 223          */
 224         SCIC_PHY_COUNTER_LOSS_OF_SYNC_ERROR,
 225
 226         /**
 227          * This PHY information field tracks the number of received DWORDs with
 228          * running disparity errors.
 229          */
 230         SCIC_PHY_COUNTER_RECEIVED_DISPARITY_ERROR,
 231
 232         /**
 233          * This PHY information field tracks the number of received frames with a
 234          * CRC error (not including short or truncated frames).
 235          */
 236         SCIC_PHY_COUNTER_RECEIVED_FRAME_CRC_ERROR,
 237
 238         /**
 239          * This PHY information field tracks the number of DONE (ACK/NAK TIMEOUT)
 240          * primitives received.
 241          */
 242         SCIC_PHY_COUNTER_RECEIVED_DONE_ACK_NAK_TIMEOUT,
 243
 244         /**
 245          * This PHY information field tracks the number of DONE (ACK/NAK TIMEOUT)
 246          * primitives transmitted.
 247          */
 248         SCIC_PHY_COUNTER_TRANSMITTED_DONE_ACK_NAK_TIMEOUT,
 249
 250         /**
 251          * This PHY information field tracks the number of times the inactivity
 252          * timer for connections on the phy has been utilized.
 253          */
 254         SCIC_PHY_COUNTER_INACTIVITY_TIMER_EXPIRED,
 255
 256         /**
 257          * This PHY information field tracks the number of DONE (CREDIT TIMEOUT)
 258          * primitives received.
 259          */
 260         SCIC_PHY_COUNTER_RECEIVED_DONE_CREDIT_TIMEOUT,
 261
 262         /**
 263          * This PHY information field tracks the number of DONE (CREDIT TIMEOUT)
 264          * primitives transmitted.
 265          */
 266         SCIC_PHY_COUNTER_TRANSMITTED_DONE_CREDIT_TIMEOUT,
 267
 268         /**
 269          * This PHY information field tracks the number of CREDIT BLOCKED
 270          * primitives received.
 271          * @note Depending on remote device implementation, credit blocks
 272          *       may occur regularly.
 273          */
 274         SCIC_PHY_COUNTER_RECEIVED_CREDIT_BLOCKED,
 275
 276         /**
 277          * This PHY information field contains the number of short frames
 278          * received.  A short frame is simply a frame smaller then what is
 279          * allowed by either the SAS or SATA specification.
 280          */
 281         SCIC_PHY_COUNTER_RECEIVED_SHORT_FRAME,
 282
 283         /**
 284          * This PHY information field contains the number of frames received after
 285          * credit has been exhausted.
 286          */
 287         SCIC_PHY_COUNTER_RECEIVED_FRAME_WITHOUT_CREDIT,
 288
 289         /**
 290          * This PHY information field contains the number of frames received after
 291          * a DONE has been received.
 292          */
 293         SCIC_PHY_COUNTER_RECEIVED_FRAME_AFTER_DONE,
 294
 295         /**
 296          * This PHY information field contains the number of times the phy
 297          * failed to achieve DWORD synchronization during speed negotiation.
 298          */
 299         SCIC_PHY_COUNTER_SN_DWORD_SYNC_ERROR
 300 };
 301
 302 #endif  /* _SCIC_PHY_H_ */