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
;
145 struct sci_base_state_machine starting_substate_machine
;
148 * This field is the pointer to the transport layer register for the SCU
151 struct scu_transport_layer_registers __iomem
*transport_layer_registers
;
154 * This field points to the link layer register set within the SCU.
156 struct scu_link_layer_registers __iomem
*link_layer_registers
;
162 struct scic_sds_phy sci
;
163 struct asd_sas_phy sas_phy
;
164 struct isci_port
*isci_port
;
165 u8 sas_addr
[SAS_ADDR_SIZE
];
168 struct sas_identify_frame iaf
;
169 struct dev_to_host_fis fis
;
173 static inline struct isci_phy
*to_isci_phy(struct asd_sas_phy
*sas_phy
)
175 struct isci_phy
*iphy
= container_of(sas_phy
, typeof(*iphy
), sas_phy
);
180 static inline struct isci_phy
*sci_phy_to_iphy(struct scic_sds_phy
*sci_phy
)
182 struct isci_phy
*iphy
= container_of(sci_phy
, typeof(*iphy
), sci
);
187 struct scic_phy_cap
{
191 * The SAS specification indicates the start bit shall
193 * 1. This implementation will have the start bit set
194 * to 0 if the PHY CAPABILITIES were either not
195 * received or speed negotiation failed.
200 u8 req_logical_linkrate
:4;
215 /* this data structure reflects the link layer transmit identification reg */
216 struct scic_phy_proto
{
236 * struct scic_phy_properties - This structure defines the properties common to
237 * all phys that can be retrieved.
241 struct scic_phy_properties
{
243 * This field specifies the port that currently contains the
244 * supplied phy. This field may be set to NULL
245 * if the phy is not currently contained in a port.
247 struct scic_sds_port
*owning_port
;
250 * This field specifies the link rate at which the phy is
251 * currently operating.
253 enum sas_linkrate negotiated_link_rate
;
256 * This field specifies the index of the phy in relation to other
257 * phys within the controller. This index is zero relative.
263 * struct scic_sas_phy_properties - This structure defines the properties,
264 * specific to a SAS phy, that can be retrieved.
268 struct scic_sas_phy_properties
{
270 * This field delineates the Identify Address Frame received
271 * from the remote end point.
273 struct sas_identify_frame rcvd_iaf
;
276 * This field delineates the Phy capabilities structure received
277 * from the remote end point.
279 struct scic_phy_cap rcvd_cap
;
284 * struct scic_sata_phy_properties - This structure defines the properties,
285 * specific to a SATA phy, that can be retrieved.
289 struct scic_sata_phy_properties
{
291 * This field delineates the signature FIS received from the
294 struct dev_to_host_fis signature_fis
;
297 * This field specifies to the user if a port selector is connected
298 * on the specified phy.
300 bool is_port_selector_present
;
305 * enum scic_phy_counter_id - This enumeration depicts the various pieces of
306 * optional information that can be retrieved for a specific phy.
310 enum scic_phy_counter_id
{
312 * This PHY information field tracks the number of frames received.
314 SCIC_PHY_COUNTER_RECEIVED_FRAME
,
317 * This PHY information field tracks the number of frames transmitted.
319 SCIC_PHY_COUNTER_TRANSMITTED_FRAME
,
322 * This PHY information field tracks the number of DWORDs received.
324 SCIC_PHY_COUNTER_RECEIVED_FRAME_WORD
,
327 * This PHY information field tracks the number of DWORDs transmitted.
329 SCIC_PHY_COUNTER_TRANSMITTED_FRAME_DWORD
,
332 * This PHY information field tracks the number of times DWORD
333 * synchronization was lost.
335 SCIC_PHY_COUNTER_LOSS_OF_SYNC_ERROR
,
338 * This PHY information field tracks the number of received DWORDs with
339 * running disparity errors.
341 SCIC_PHY_COUNTER_RECEIVED_DISPARITY_ERROR
,
344 * This PHY information field tracks the number of received frames with a
345 * CRC error (not including short or truncated frames).
347 SCIC_PHY_COUNTER_RECEIVED_FRAME_CRC_ERROR
,
350 * This PHY information field tracks the number of DONE (ACK/NAK TIMEOUT)
351 * primitives received.
353 SCIC_PHY_COUNTER_RECEIVED_DONE_ACK_NAK_TIMEOUT
,
356 * This PHY information field tracks the number of DONE (ACK/NAK TIMEOUT)
357 * primitives transmitted.
359 SCIC_PHY_COUNTER_TRANSMITTED_DONE_ACK_NAK_TIMEOUT
,
362 * This PHY information field tracks the number of times the inactivity
363 * timer for connections on the phy has been utilized.
365 SCIC_PHY_COUNTER_INACTIVITY_TIMER_EXPIRED
,
368 * This PHY information field tracks the number of DONE (CREDIT TIMEOUT)
369 * primitives received.
371 SCIC_PHY_COUNTER_RECEIVED_DONE_CREDIT_TIMEOUT
,
374 * This PHY information field tracks the number of DONE (CREDIT TIMEOUT)
375 * primitives transmitted.
377 SCIC_PHY_COUNTER_TRANSMITTED_DONE_CREDIT_TIMEOUT
,
380 * This PHY information field tracks the number of CREDIT BLOCKED
381 * primitives received.
382 * @note Depending on remote device implementation, credit blocks
383 * may occur regularly.
385 SCIC_PHY_COUNTER_RECEIVED_CREDIT_BLOCKED
,
388 * This PHY information field contains the number of short frames
389 * received. A short frame is simply a frame smaller then what is
390 * allowed by either the SAS or SATA specification.
392 SCIC_PHY_COUNTER_RECEIVED_SHORT_FRAME
,
395 * This PHY information field contains the number of frames received after
396 * credit has been exhausted.
398 SCIC_PHY_COUNTER_RECEIVED_FRAME_WITHOUT_CREDIT
,
401 * This PHY information field contains the number of frames received after
402 * a DONE has been received.
404 SCIC_PHY_COUNTER_RECEIVED_FRAME_AFTER_DONE
,
407 * This PHY information field contains the number of times the phy
408 * failed to achieve DWORD synchronization during speed negotiation.
410 SCIC_PHY_COUNTER_SN_DWORD_SYNC_ERROR
413 enum scic_sds_phy_states
{
415 * Simply the initial state for the base domain state machine.
417 SCI_BASE_PHY_STATE_INITIAL
,
420 * This state indicates that the phy has successfully been stopped.
421 * In this state no new IO operations are permitted on this phy.
422 * This state is entered from the INITIAL state.
423 * This state is entered from the STARTING state.
424 * This state is entered from the READY state.
425 * This state is entered from the RESETTING state.
427 SCI_BASE_PHY_STATE_STOPPED
,
430 * This state indicates that the phy is in the process of becomming
431 * ready. In this state no new IO operations are permitted on this phy.
432 * This state is entered from the STOPPED state.
433 * This state is entered from the READY state.
434 * This state is entered from the RESETTING state.
436 SCI_BASE_PHY_STATE_STARTING
,
439 * This state indicates the the phy is now ready. Thus, the user
440 * is able to perform IO operations utilizing this phy as long as it
441 * is currently part of a valid port.
442 * This state is entered from the STARTING state.
444 SCI_BASE_PHY_STATE_READY
,
447 * This state indicates that the phy is in the process of being reset.
448 * In this state no new IO operations are permitted on this phy.
449 * This state is entered from the READY state.
451 SCI_BASE_PHY_STATE_RESETTING
,
454 * Simply the final state for the base phy state machine.
456 SCI_BASE_PHY_STATE_FINAL
,
461 * enum scic_sds_phy_starting_substates -
465 enum scic_sds_phy_starting_substates
{
469 SCIC_SDS_PHY_STARTING_SUBSTATE_INITIAL
,
472 * Wait state for the hardware OSSP event type notification
474 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_OSSP_EN
,
477 * Wait state for the PHY speed notification
479 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SAS_SPEED_EN
,
482 * Wait state for the IAF Unsolicited frame notification
484 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_IAF_UF
,
487 * Wait state for the request to consume power
489 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SAS_POWER
,
492 * Wait state for request to consume power
494 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SATA_POWER
,
497 * Wait state for the SATA PHY notification
499 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SATA_PHY_EN
,
502 * Wait for the SATA PHY speed notification
504 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SATA_SPEED_EN
,
507 * Wait state for the SIGNATURE FIS unsolicited frame notification
509 SCIC_SDS_PHY_STARTING_SUBSTATE_AWAIT_SIG_FIS_UF
,
512 * Exit state for this state machine
514 SCIC_SDS_PHY_STARTING_SUBSTATE_FINAL
,
519 typedef enum sci_status (*scic_sds_phy_handler_t
)(struct scic_sds_phy
*);
520 typedef enum sci_status (*scic_sds_phy_event_handler_t
)(struct scic_sds_phy
*, u32
);
521 typedef enum sci_status (*scic_sds_phy_frame_handler_t
)(struct scic_sds_phy
*, u32
);
522 typedef enum sci_status (*scic_sds_phy_power_handler_t
)(struct scic_sds_phy
*);
524 struct scic_sds_phy_state_handler
{
526 * The start_handler specifies the method invoked when there is an
527 * attempt to start a phy.
529 scic_sds_phy_handler_t start_handler
;
532 * The stop_handler specifies the method invoked when there is an
533 * attempt to stop a phy.
535 scic_sds_phy_handler_t stop_handler
;
538 * The reset_handler specifies the method invoked when there is an
539 * attempt to reset a phy.
541 scic_sds_phy_handler_t reset_handler
;
544 * The destruct_handler specifies the method invoked when attempting to
547 scic_sds_phy_handler_t destruct_handler
;
550 * The state handler for unsolicited frames received from the SCU hardware.
552 scic_sds_phy_frame_handler_t frame_handler
;
555 * The state handler for events received from the SCU hardware.
557 scic_sds_phy_event_handler_t event_handler
;
560 * The state handler for staggered spinup.
562 scic_sds_phy_power_handler_t consume_power_handler
;
567 * scic_sds_phy_get_index() -
569 * This macro returns the phy index for the specified phy
571 #define scic_sds_phy_get_index(phy) \
575 * scic_sds_phy_get_controller() - This macro returns the controller for this
580 #define scic_sds_phy_get_controller(phy) \
581 (scic_sds_port_get_controller((phy)->owning_port))
584 * scic_sds_phy_set_state_handlers() - This macro sets the state handlers for
589 #define scic_sds_phy_set_state_handlers(phy, handlers) \
590 ((phy)->state_handlers = (handlers))
593 * scic_sds_phy_set_base_state_handlers() -
595 * This macro set the base state handlers for the phy object.
597 #define scic_sds_phy_set_base_state_handlers(phy, state_id) \
598 scic_sds_phy_set_state_handlers(\
600 &scic_sds_phy_state_handler_table[(state_id)] \
603 void scic_sds_phy_construct(
604 struct scic_sds_phy
*this_phy
,
605 struct scic_sds_port
*owning_port
,
608 struct scic_sds_port
*scic_sds_phy_get_port(
609 struct scic_sds_phy
*this_phy
);
611 void scic_sds_phy_set_port(
612 struct scic_sds_phy
*this_phy
,
613 struct scic_sds_port
*owning_port
);
615 enum sci_status
scic_sds_phy_initialize(
616 struct scic_sds_phy
*this_phy
,
617 struct scu_transport_layer_registers __iomem
*transport_layer_registers
,
618 struct scu_link_layer_registers __iomem
*link_layer_registers
);
620 enum sci_status
scic_sds_phy_start(
621 struct scic_sds_phy
*this_phy
);
623 enum sci_status
scic_sds_phy_stop(
624 struct scic_sds_phy
*this_phy
);
626 enum sci_status
scic_sds_phy_reset(
627 struct scic_sds_phy
*this_phy
);
629 void scic_sds_phy_resume(
630 struct scic_sds_phy
*this_phy
);
632 void scic_sds_phy_setup_transport(
633 struct scic_sds_phy
*this_phy
,
636 enum sci_status
scic_sds_phy_event_handler(
637 struct scic_sds_phy
*this_phy
,
640 enum sci_status
scic_sds_phy_frame_handler(
641 struct scic_sds_phy
*this_phy
,
644 enum sci_status
scic_sds_phy_consume_power_handler(
645 struct scic_sds_phy
*this_phy
);
647 void scic_sds_phy_get_sas_address(
648 struct scic_sds_phy
*this_phy
,
649 struct sci_sas_address
*sas_address
);
651 void scic_sds_phy_get_attached_sas_address(
652 struct scic_sds_phy
*this_phy
,
653 struct sci_sas_address
*sas_address
);
655 struct scic_phy_proto
;
656 void scic_sds_phy_get_protocols(
657 struct scic_sds_phy
*sci_phy
,
658 struct scic_phy_proto
*protocols
);
659 enum sas_linkrate
sci_phy_linkrate(struct scic_sds_phy
*sci_phy
);
662 void isci_phy_init(struct isci_phy
*iphy
, struct isci_host
*ihost
, int index
);
663 int isci_phy_control(struct asd_sas_phy
*phy
, enum phy_func func
, void *buf
);
665 #endif /* !defined(_ISCI_PHY_H_) */