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