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