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