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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
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.
59 #include <scsi/libsas.h>
60 #include "state_machine.h"
63 /* This is the timeout value for the SATA phy to wait for a SIGNATURE FIS
64 * before restarting the starting state machine. Technically, the old parallel
65 * ATA specification required up to 30 seconds for a device to issue its
66 * signature FIS as a result of a soft reset. Now we see that devices respond
67 * generally within 15 seconds, but we'll use 25 for now.
69 #define SCIC_SDS_SIGNATURE_FIS_TIMEOUT 25000
71 /* This is the timeout for the SATA OOB/SN because the hardware does not
72 * recognize a hot plug after OOB signal but before the SN signals. We need to
73 * make sure after a hotplug timeout if we have not received the speed event
74 * notification from the hardware that we restart the hardware OOB state
77 #define SCIC_SDS_SATA_LINK_TRAINING_TIMEOUT 250
79 enum scic_sds_phy_protocol {
80 SCIC_SDS_PHY_PROTOCOL_UNKNOWN,
81 SCIC_SDS_PHY_PROTOCOL_SAS,
82 SCIC_SDS_PHY_PROTOCOL_SATA,
83 SCIC_SDS_MAX_PHY_PROTOCOLS
87 * struct scic_sds_phy - This structure contains or references all of the data
88 * necessary to represent the core phy object and SCU harware protocol
95 * This field contains the information for the base phy state machine.
97 struct sci_base_state_machine state_machine;
100 * This field specifies the port object that owns/contains this phy.
102 struct scic_sds_port *owning_port;
105 * This field indicates whether the phy supports 1.5 Gb/s, 3.0 Gb/s,
106 * or 6.0 Gb/s operation.
108 enum sas_linkrate max_negotiated_speed;
111 * This member specifies the protocol being utilized on this phy. This
112 * field contains a legitamite value once the PHY has link trained with
115 enum scic_sds_phy_protocol protocol;
118 * This field specifies the index with which this phy is associated (0-3).
123 * This member indicates if this particular PHY has received a BCN while
124 * it had no port assignement. This BCN will be reported once the phy is
125 * assigned to a port.
127 bool bcn_received_while_port_unassigned;
130 * This field indicates if this PHY is currently in the process of
131 * link training (i.e. it has started OOB, but has yet to perform
132 * IAF exchange/Signature FIS reception).
134 bool is_in_link_training;
137 * This field contains a reference to the timer utilized in detecting
138 * when a signature FIS timeout has occurred. The signature FIS is the
139 * first FIS sent by an attached SATA device after OOB/SN.
141 void *sata_timeout_timer;
143 const struct scic_sds_phy_state_handler *state_handlers;
146 * This field is the pointer to the transport layer register for the SCU
149 struct scu_transport_layer_registers __iomem *transport_layer_registers;
152 * This field points to the link layer register set within the SCU.
154 struct scu_link_layer_registers __iomem *link_layer_registers;
160 struct scic_sds_phy sci;
161 struct asd_sas_phy sas_phy;
162 struct isci_port *isci_port;
163 u8 sas_addr[SAS_ADDR_SIZE];
166 struct sas_identify_frame iaf;
167 struct dev_to_host_fis fis;
171 static inline struct isci_phy *to_isci_phy(struct asd_sas_phy *sas_phy)
173 struct isci_phy *iphy = container_of(sas_phy, typeof(*iphy), sas_phy);
178 static inline struct isci_phy *sci_phy_to_iphy(struct scic_sds_phy *sci_phy)
180 struct isci_phy *iphy = container_of(sci_phy, typeof(*iphy), sci);
185 struct scic_phy_cap {
189 * The SAS specification indicates the start bit shall
191 * 1. This implementation will have the start bit set
192 * to 0 if the PHY CAPABILITIES were either not
193 * received or speed negotiation failed.
198 u8 req_logical_linkrate:4;
213 /* this data structure reflects the link layer transmit identification reg */
214 struct scic_phy_proto {
234 * struct scic_phy_properties - This structure defines the properties common to
235 * all phys that can be retrieved.
239 struct scic_phy_properties {
241 * This field specifies the port that currently contains the
242 * supplied phy. This field may be set to NULL
243 * if the phy is not currently contained in a port.
245 struct scic_sds_port *owning_port;
248 * This field specifies the link rate at which the phy is
249 * currently operating.
251 enum sas_linkrate negotiated_link_rate;
254 * This field specifies the index of the phy in relation to other
255 * phys within the controller. This index is zero relative.
261 * struct scic_sas_phy_properties - This structure defines the properties,
262 * specific to a SAS phy, that can be retrieved.
266 struct scic_sas_phy_properties {
268 * This field delineates the Identify Address Frame received
269 * from the remote end point.
271 struct sas_identify_frame rcvd_iaf;
274 * This field delineates the Phy capabilities structure received
275 * from the remote end point.
277 struct scic_phy_cap rcvd_cap;
282 * struct scic_sata_phy_properties - This structure defines the properties,
283 * specific to a SATA phy, that can be retrieved.
287 struct scic_sata_phy_properties {
289 * This field delineates the signature FIS received from the
292 struct dev_to_host_fis signature_fis;
295 * This field specifies to the user if a port selector is connected
296 * on the specified phy.
298 bool is_port_selector_present;
303 * enum scic_phy_counter_id - This enumeration depicts the various pieces of
304 * optional information that can be retrieved for a specific phy.
308 enum scic_phy_counter_id {
310 * This PHY information field tracks the number of frames received.
312 SCIC_PHY_COUNTER_RECEIVED_FRAME,
315 * This PHY information field tracks the number of frames transmitted.
317 SCIC_PHY_COUNTER_TRANSMITTED_FRAME,
320 * This PHY information field tracks the number of DWORDs received.
322 SCIC_PHY_COUNTER_RECEIVED_FRAME_WORD,
325 * This PHY information field tracks the number of DWORDs transmitted.
327 SCIC_PHY_COUNTER_TRANSMITTED_FRAME_DWORD,
330 * This PHY information field tracks the number of times DWORD
331 * synchronization was lost.
333 SCIC_PHY_COUNTER_LOSS_OF_SYNC_ERROR,
336 * This PHY information field tracks the number of received DWORDs with
337 * running disparity errors.
339 SCIC_PHY_COUNTER_RECEIVED_DISPARITY_ERROR,
342 * This PHY information field tracks the number of received frames with a
343 * CRC error (not including short or truncated frames).
345 SCIC_PHY_COUNTER_RECEIVED_FRAME_CRC_ERROR,
348 * This PHY information field tracks the number of DONE (ACK/NAK TIMEOUT)
349 * primitives received.
351 SCIC_PHY_COUNTER_RECEIVED_DONE_ACK_NAK_TIMEOUT,
354 * This PHY information field tracks the number of DONE (ACK/NAK TIMEOUT)
355 * primitives transmitted.
357 SCIC_PHY_COUNTER_TRANSMITTED_DONE_ACK_NAK_TIMEOUT,
360 * This PHY information field tracks the number of times the inactivity
361 * timer for connections on the phy has been utilized.
363 SCIC_PHY_COUNTER_INACTIVITY_TIMER_EXPIRED,
366 * This PHY information field tracks the number of DONE (CREDIT TIMEOUT)
367 * primitives received.
369 SCIC_PHY_COUNTER_RECEIVED_DONE_CREDIT_TIMEOUT,
372 * This PHY information field tracks the number of DONE (CREDIT TIMEOUT)
373 * primitives transmitted.
375 SCIC_PHY_COUNTER_TRANSMITTED_DONE_CREDIT_TIMEOUT,
378 * This PHY information field tracks the number of CREDIT BLOCKED
379 * primitives received.
380 * @note Depending on remote device implementation, credit blocks
381 * may occur regularly.
383 SCIC_PHY_COUNTER_RECEIVED_CREDIT_BLOCKED,
386 * This PHY information field contains the number of short frames
387 * received. A short frame is simply a frame smaller then what is
388 * allowed by either the SAS or SATA specification.
390 SCIC_PHY_COUNTER_RECEIVED_SHORT_FRAME,
393 * This PHY information field contains the number of frames received after
394 * credit has been exhausted.
396 SCIC_PHY_COUNTER_RECEIVED_FRAME_WITHOUT_CREDIT,
399 * This PHY information field contains the number of frames received after
400 * a DONE has been received.
402 SCIC_PHY_COUNTER_RECEIVED_FRAME_AFTER_DONE,
405 * This PHY information field contains the number of times the phy
406 * failed to achieve DWORD synchronization during speed negotiation.
408 SCIC_PHY_COUNTER_SN_DWORD_SYNC_ERROR
411 enum scic_sds_phy_states {
413 * Simply the initial state for the base domain state machine.
415 SCI_BASE_PHY_STATE_INITIAL,
418 * This state indicates that the phy has successfully been stopped.
419 * In this state no new IO operations are permitted on this phy.
420 * This state is entered from the INITIAL state.
421 * This state is entered from the STARTING state.
422 * This state is entered from the READY state.
423 * This state is entered from the RESETTING state.
425 SCI_BASE_PHY_STATE_STOPPED,
428 * This state indicates that the phy is in the process of becomming
429 * ready. In this state no new IO operations are permitted on this phy.
430 * This state is entered from the STOPPED state.
431 * This state is entered from the READY state.
432 * This state is entered from the RESETTING state.
434 SCI_BASE_PHY_STATE_STARTING,
439 SCIC_SDS_PHY_STARTING_SUBSTATE_INITIAL,
442 * Wait state for the hardware OSSP event type notification
444 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_OSSP_EN,
447 * Wait state for the PHY speed notification
449 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SAS_SPEED_EN,
452 * Wait state for the IAF Unsolicited frame notification
454 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_IAF_UF,
457 * Wait state for the request to consume power
459 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SAS_POWER,
462 * Wait state for request to consume power
464 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SATA_POWER,
467 * Wait state for the SATA PHY notification
469 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SATA_PHY_EN,
472 * Wait for the SATA PHY speed notification
474 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SATA_SPEED_EN,
477 * Wait state for the SIGNATURE FIS unsolicited frame notification
479 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SIG_FIS_UF,
482 * Exit state for this state machine
484 SCIC_SDS_PHY_STARTING_SUBSTATE_FINAL,
487 * This state indicates the the phy is now ready. Thus, the user
488 * is able to perform IO operations utilizing this phy as long as it
489 * is currently part of a valid port.
490 * This state is entered from the STARTING state.
492 SCI_BASE_PHY_STATE_READY,
495 * This state indicates that the phy is in the process of being reset.
496 * In this state no new IO operations are permitted on this phy.
497 * This state is entered from the READY state.
499 SCI_BASE_PHY_STATE_RESETTING,
502 * Simply the final state for the base phy state machine.
504 SCI_BASE_PHY_STATE_FINAL,
508 typedef enum sci_status (*scic_sds_phy_handler_t)(struct scic_sds_phy *);
509 typedef enum sci_status (*scic_sds_phy_event_handler_t)(struct scic_sds_phy *, u32);
510 typedef enum sci_status (*scic_sds_phy_frame_handler_t)(struct scic_sds_phy *, u32);
511 typedef enum sci_status (*scic_sds_phy_power_handler_t)(struct scic_sds_phy *);
513 struct scic_sds_phy_state_handler {
515 * The destruct_handler specifies the method invoked when attempting to
518 scic_sds_phy_handler_t destruct_handler;
521 * The state handler for unsolicited frames received from the SCU hardware.
523 scic_sds_phy_frame_handler_t frame_handler;
526 * The state handler for events received from the SCU hardware.
528 scic_sds_phy_event_handler_t event_handler;
531 * The state handler for staggered spinup.
533 scic_sds_phy_power_handler_t consume_power_handler;
538 * scic_sds_phy_get_index() -
540 * This macro returns the phy index for the specified phy
542 #define scic_sds_phy_get_index(phy) \
546 * scic_sds_phy_get_controller() - This macro returns the controller for this
551 #define scic_sds_phy_get_controller(phy) \
552 (scic_sds_port_get_controller((phy)->owning_port))
555 * scic_sds_phy_set_state_handlers() - This macro sets the state handlers for
560 #define scic_sds_phy_set_state_handlers(phy, handlers) \
561 ((phy)->state_handlers = (handlers))
564 * scic_sds_phy_set_base_state_handlers() -
566 * This macro set the base state handlers for the phy object.
568 #define scic_sds_phy_set_base_state_handlers(phy, state_id) \
569 scic_sds_phy_set_state_handlers(\
571 &scic_sds_phy_state_handler_table[(state_id)] \
574 void scic_sds_phy_construct(
575 struct scic_sds_phy *this_phy,
576 struct scic_sds_port *owning_port,
579 struct scic_sds_port *scic_sds_phy_get_port(
580 struct scic_sds_phy *this_phy);
582 void scic_sds_phy_set_port(
583 struct scic_sds_phy *this_phy,
584 struct scic_sds_port *owning_port);
586 enum sci_status scic_sds_phy_initialize(
587 struct scic_sds_phy *this_phy,
588 struct scu_transport_layer_registers __iomem *transport_layer_registers,
589 struct scu_link_layer_registers __iomem *link_layer_registers);
591 enum sci_status scic_sds_phy_start(
592 struct scic_sds_phy *this_phy);
594 enum sci_status scic_sds_phy_stop(
595 struct scic_sds_phy *this_phy);
597 enum sci_status scic_sds_phy_reset(
598 struct scic_sds_phy *this_phy);
600 void scic_sds_phy_resume(
601 struct scic_sds_phy *this_phy);
603 void scic_sds_phy_setup_transport(
604 struct scic_sds_phy *this_phy,
607 enum sci_status scic_sds_phy_event_handler(
608 struct scic_sds_phy *this_phy,
611 enum sci_status scic_sds_phy_frame_handler(
612 struct scic_sds_phy *this_phy,
615 enum sci_status scic_sds_phy_consume_power_handler(
616 struct scic_sds_phy *this_phy);
618 void scic_sds_phy_get_sas_address(
619 struct scic_sds_phy *this_phy,
620 struct sci_sas_address *sas_address);
622 void scic_sds_phy_get_attached_sas_address(
623 struct scic_sds_phy *this_phy,
624 struct sci_sas_address *sas_address);
626 struct scic_phy_proto;
627 void scic_sds_phy_get_protocols(
628 struct scic_sds_phy *sci_phy,
629 struct scic_phy_proto *protocols);
630 enum sas_linkrate sci_phy_linkrate(struct scic_sds_phy *sci_phy);
633 void isci_phy_init(struct isci_phy *iphy, struct isci_host *ihost, int index);
634 int isci_phy_control(struct asd_sas_phy *phy, enum phy_func func, void *buf);
636 #endif /* !defined(_ISCI_PHY_H_) */