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.
58 #include "remote_device.h"
61 #include "state_machine.h"
62 #include "remote_node_table.h"
63 #include "registers.h"
64 #include "scu_unsolicited_frame.h"
65 #include "unsolicited_frame_control.h"
66 #include "probe_roms.h"
68 struct scic_sds_request
;
69 struct scu_task_context
;
73 * struct scic_power_control -
75 * This structure defines the fields for managing power control for direct
76 * attached disk devices.
78 struct scic_power_control
{
80 * This field is set when the power control timer is running and cleared when
86 * Timer to control when the directed attached disks can consume power.
88 struct sci_timer timer
;
91 * This field is used to keep track of how many phys are put into the
97 * This field is used to keep track of how many phys have been granted to consume power
99 u8 phys_granted_power
;
102 * This field is an array of phys that we are waiting on. The phys are direct
103 * mapped into requesters via struct scic_sds_phy.phy_index
105 struct scic_sds_phy
*requesters
[SCI_MAX_PHYS
];
109 struct scic_sds_port_configuration_agent
;
110 typedef void (*port_config_fn
)(struct scic_sds_controller
*,
111 struct scic_sds_port_configuration_agent
*,
112 struct scic_sds_port
*, struct scic_sds_phy
*);
114 struct scic_sds_port_configuration_agent
{
115 u16 phy_configured_mask
;
120 } phy_valid_port_range
[SCI_MAX_PHYS
];
122 port_config_fn link_up_handler
;
123 port_config_fn link_down_handler
;
124 struct sci_timer timer
;
128 * struct scic_sds_controller -
130 * This structure represents the SCU controller object.
132 struct scic_sds_controller
{
134 * This field contains the information for the base controller state
137 struct sci_base_state_machine state_machine
;
140 * This field is the driver timer object handler used to time the controller
141 * object start and stop requests.
146 * This field contains the user parameters to be utilized for this
147 * core controller object.
149 union scic_user_parameters user_parameters
;
152 * This field contains the OEM parameters to be utilized for this
153 * core controller object.
155 union scic_oem_parameters oem_parameters
;
158 * This field contains the port configuration agent for this controller.
160 struct scic_sds_port_configuration_agent port_agent
;
163 * This field is the array of device objects that are currently constructed
164 * for this controller object. This table is used as a fast lookup of device
165 * objects that need to handle device completion notifications from the
166 * hardware. The table is RNi based.
168 struct scic_sds_remote_device
*device_table
[SCI_MAX_REMOTE_DEVICES
];
171 * This field is the array of IO request objects that are currently active for
172 * this controller object. This table is used as a fast lookup of the io
173 * request object that need to handle completion queue notifications. The
174 * table is TCi based.
176 struct scic_sds_request
*io_request_table
[SCI_MAX_IO_REQUESTS
];
179 * This field is the free RNi data structure
181 struct scic_remote_node_table available_remote_nodes
;
184 * This field is the TCi pool used to manage the task context index.
186 SCI_POOL_CREATE(tci_pool
, u16
, SCI_MAX_IO_REQUESTS
);
189 * This filed is the struct scic_power_control data used to controll when direct
190 * attached devices can consume power.
192 struct scic_power_control power_control
;
195 * This field is the array of sequence values for the IO Tag fields. Even
196 * though only 4 bits of the field is used for the sequence the sequence is 16
197 * bits in size so the sequence can be bitwise or'd with the TCi to build the
200 u16 io_request_sequence
[SCI_MAX_IO_REQUESTS
];
203 * This field in the array of sequence values for the RNi. These are used
204 * to control io request build to io request start operations. The sequence
205 * value is recorded into an io request when it is built and is checked on
206 * the io request start operation to make sure that there was not a device
207 * hot plug between the build and start operation.
209 u8 remote_device_sequence
[SCI_MAX_REMOTE_DEVICES
];
212 * This field is a pointer to the memory allocated by the driver for the task
213 * context table. This data is shared between the hardware and software.
215 struct scu_task_context
*task_context_table
;
218 * This field is a pointer to the memory allocated by the driver for the
219 * remote node context table. This table is shared between the hardware and
222 union scu_remote_node_context
*remote_node_context_table
;
225 * This field is a pointer to the completion queue. This memory is
226 * written to by the hardware and read by the software.
228 u32
*completion_queue
;
231 * This field is the software copy of the completion queue get pointer. The
232 * controller object writes this value to the hardware after processing the
233 * completion entries.
235 u32 completion_queue_get
;
238 * This field is the minimum of the number of hardware supported port entries
239 * and the software requested port entries.
241 u32 logical_port_entries
;
244 * This field is the minimum number of hardware supported completion queue
245 * entries and the software requested completion queue entries.
247 u32 completion_queue_entries
;
250 * This field is the minimum number of hardware supported event entries and
251 * the software requested event entries.
253 u32 completion_event_entries
;
256 * This field is the minimum number of devices supported by the hardware and
257 * the number of devices requested by the software.
259 u32 remote_node_entries
;
262 * This field is the minimum number of IO requests supported by the hardware
263 * and the number of IO requests requested by the software.
265 u32 task_context_entries
;
268 * This object contains all of the unsolicited frame specific
269 * data utilized by the core controller.
271 struct scic_sds_unsolicited_frame_control uf_control
;
273 /* Phy Startup Data */
275 * This field is the driver timer handle for controller phy request startup.
276 * On controller start the controller will start each PHY individually in
277 * order of phy index.
279 void *phy_startup_timer
;
282 * This field is set when the phy_startup_timer is running and is cleared when
283 * the phy_startup_timer is stopped.
285 bool phy_startup_timer_pending
;
288 * This field is the index of the next phy start. It is initialized to 0 and
289 * increments for each phy index that is started.
291 u32 next_phy_to_start
;
294 * This field controlls the invalid link up notifications to the SCI_USER. If
295 * an invalid_link_up notification is reported a bit for the PHY index is set
296 * so further notifications are not made. Once the PHY object reports link up
297 * and is made part of a port then this bit for the PHY index is cleared.
302 * This field saves the current interrupt coalescing number of the controller.
304 u16 interrupt_coalesce_number
;
307 * This field saves the current interrupt coalescing timeout value in microseconds.
309 u32 interrupt_coalesce_timeout
;
312 * This field is a pointer to the memory mapped register space for the
313 * struct smu_registers.
315 struct smu_registers __iomem
*smu_registers
;
318 * This field is a pointer to the memory mapped register space for the
319 * struct scu_registers.
321 struct scu_registers __iomem
*scu_registers
;
326 struct scic_sds_controller sci
;
327 union scic_oem_parameters oem_parameters
;
329 int id
; /* unique within a given pci device */
330 struct list_head timers
;
331 void *core_ctrl_memory
;
332 struct dma_pool
*dma_pool
;
333 struct isci_phy phys
[SCI_MAX_PHYS
];
334 struct isci_port ports
[SCI_MAX_PORTS
+ 1]; /* includes dummy port */
335 struct sas_ha_struct sas_ha
;
338 spinlock_t queue_lock
;
339 spinlock_t state_lock
;
341 struct pci_dev
*pdev
;
343 enum isci_status status
;
344 #define IHOST_START_PENDING 0
345 #define IHOST_STOP_PENDING 1
347 wait_queue_head_t eventq
;
348 struct Scsi_Host
*shost
;
349 struct tasklet_struct completion_tasklet
;
350 struct list_head requests_to_complete
;
351 struct list_head requests_to_errorback
;
352 spinlock_t scic_lock
;
354 struct isci_remote_device devices
[SCI_MAX_REMOTE_DEVICES
];
358 * enum scic_sds_controller_states - This enumeration depicts all the states
359 * for the common controller state machine.
361 enum scic_sds_controller_states
{
363 * Simply the initial state for the base controller state machine.
365 SCI_BASE_CONTROLLER_STATE_INITIAL
= 0,
368 * This state indicates that the controller is reset. The memory for
369 * the controller is in it's initial state, but the controller requires
371 * This state is entered from the INITIAL state.
372 * This state is entered from the RESETTING state.
374 SCI_BASE_CONTROLLER_STATE_RESET
,
377 * This state is typically an action state that indicates the controller
378 * is in the process of initialization. In this state no new IO operations
380 * This state is entered from the RESET state.
382 SCI_BASE_CONTROLLER_STATE_INITIALIZING
,
385 * This state indicates that the controller has been successfully
386 * initialized. In this state no new IO operations are permitted.
387 * This state is entered from the INITIALIZING state.
389 SCI_BASE_CONTROLLER_STATE_INITIALIZED
,
392 * This state indicates the the controller is in the process of becoming
393 * ready (i.e. starting). In this state no new IO operations are permitted.
394 * This state is entered from the INITIALIZED state.
396 SCI_BASE_CONTROLLER_STATE_STARTING
,
399 * This state indicates the controller is now ready. Thus, the user
400 * is able to perform IO operations on the controller.
401 * This state is entered from the STARTING state.
403 SCI_BASE_CONTROLLER_STATE_READY
,
406 * This state is typically an action state that indicates the controller
407 * is in the process of resetting. Thus, the user is unable to perform
408 * IO operations on the controller. A reset is considered destructive in
410 * This state is entered from the READY state.
411 * This state is entered from the FAILED state.
412 * This state is entered from the STOPPED state.
414 SCI_BASE_CONTROLLER_STATE_RESETTING
,
417 * This state indicates that the controller is in the process of stopping.
418 * In this state no new IO operations are permitted, but existing IO
419 * operations are allowed to complete.
420 * This state is entered from the READY state.
422 SCI_BASE_CONTROLLER_STATE_STOPPING
,
425 * This state indicates that the controller has successfully been stopped.
426 * In this state no new IO operations are permitted.
427 * This state is entered from the STOPPING state.
429 SCI_BASE_CONTROLLER_STATE_STOPPED
,
432 * This state indicates that the controller could not successfully be
433 * initialized. In this state no new IO operations are permitted.
434 * This state is entered from the INITIALIZING state.
435 * This state is entered from the STARTING state.
436 * This state is entered from the STOPPING state.
437 * This state is entered from the RESETTING state.
439 SCI_BASE_CONTROLLER_STATE_FAILED
,
441 SCI_BASE_CONTROLLER_MAX_STATES
448 * struct isci_pci_info - This class represents the pci function containing the
449 * controllers. Depending on PCI SKU, there could be up to 2 controllers in
452 #define SCI_MAX_MSIX_INT (SCI_NUM_MSI_X_INT*SCI_MAX_CONTROLLERS)
454 struct isci_pci_info
{
455 struct msix_entry msix_entries
[SCI_MAX_MSIX_INT
];
456 struct isci_host
*hosts
[SCI_MAX_CONTROLLERS
];
457 struct isci_orom
*orom
;
460 static inline struct isci_pci_info
*to_pci_info(struct pci_dev
*pdev
)
462 return pci_get_drvdata(pdev
);
465 #define for_each_isci_host(id, ihost, pdev) \
466 for (id = 0, ihost = to_pci_info(pdev)->hosts[id]; \
467 id < ARRAY_SIZE(to_pci_info(pdev)->hosts) && ihost; \
468 ihost = to_pci_info(pdev)->hosts[++id])
470 static inline enum isci_status
isci_host_get_state(struct isci_host
*isci_host
)
472 return isci_host
->status
;
475 static inline void isci_host_change_state(struct isci_host
*isci_host
,
476 enum isci_status status
)
480 dev_dbg(&isci_host
->pdev
->dev
,
481 "%s: isci_host = %p, state = 0x%x",
485 spin_lock_irqsave(&isci_host
->state_lock
, flags
);
486 isci_host
->status
= status
;
487 spin_unlock_irqrestore(&isci_host
->state_lock
, flags
);
491 static inline int isci_host_can_queue(struct isci_host
*isci_host
, int num
)
496 spin_lock_irqsave(&isci_host
->queue_lock
, flags
);
497 if ((isci_host
->can_queue
- num
) < 0) {
498 dev_dbg(&isci_host
->pdev
->dev
,
499 "%s: isci_host->can_queue = %d\n",
501 isci_host
->can_queue
);
502 ret
= -SAS_QUEUE_FULL
;
505 isci_host
->can_queue
-= num
;
507 spin_unlock_irqrestore(&isci_host
->queue_lock
, flags
);
512 static inline void isci_host_can_dequeue(struct isci_host
*isci_host
, int num
)
516 spin_lock_irqsave(&isci_host
->queue_lock
, flags
);
517 isci_host
->can_queue
+= num
;
518 spin_unlock_irqrestore(&isci_host
->queue_lock
, flags
);
521 static inline void wait_for_start(struct isci_host
*ihost
)
523 wait_event(ihost
->eventq
, !test_bit(IHOST_START_PENDING
, &ihost
->flags
));
526 static inline void wait_for_stop(struct isci_host
*ihost
)
528 wait_event(ihost
->eventq
, !test_bit(IHOST_STOP_PENDING
, &ihost
->flags
));
531 static inline void wait_for_device_start(struct isci_host
*ihost
, struct isci_remote_device
*idev
)
533 wait_event(ihost
->eventq
, !test_bit(IDEV_START_PENDING
, &idev
->flags
));
536 static inline void wait_for_device_stop(struct isci_host
*ihost
, struct isci_remote_device
*idev
)
538 wait_event(ihost
->eventq
, !test_bit(IDEV_STOP_PENDING
, &idev
->flags
));
541 static inline struct isci_host
*dev_to_ihost(struct domain_device
*dev
)
543 return dev
->port
->ha
->lldd_ha
;
546 static inline struct isci_host
*scic_to_ihost(struct scic_sds_controller
*scic
)
548 /* XXX delete after merging scic_sds_contoller and isci_host */
549 struct isci_host
*ihost
= container_of(scic
, typeof(*ihost
), sci
);
555 * INCREMENT_QUEUE_GET() -
557 * This macro will increment the specified index to and if the index wraps to 0
558 * it will toggel the cycle bit.
560 #define INCREMENT_QUEUE_GET(index, cycle, entry_count, bit_toggle) \
562 if ((index) + 1 == entry_count) { \
564 (cycle) = (cycle) ^ (bit_toggle); \
571 * scic_sds_controller_get_protocol_engine_group() -
573 * This macro returns the protocol engine group for this controller object.
574 * Presently we only support protocol engine group 0 so just return that
576 #define scic_sds_controller_get_protocol_engine_group(controller) 0
579 * scic_sds_io_tag_construct() -
581 * This macro constructs an IO tag from the sequence and index values.
583 #define scic_sds_io_tag_construct(sequence, task_index) \
584 ((sequence) << 12 | (task_index))
587 * scic_sds_io_tag_get_sequence() -
589 * This macro returns the IO sequence from the IO tag value.
591 #define scic_sds_io_tag_get_sequence(io_tag) \
592 (((io_tag) & 0xF000) >> 12)
595 * scic_sds_io_tag_get_index() -
597 * This macro returns the TCi from the io tag value
599 #define scic_sds_io_tag_get_index(io_tag) \
603 * scic_sds_io_sequence_increment() -
605 * This is a helper macro to increment the io sequence count. We may find in
606 * the future that it will be faster to store the sequence count in such a way
607 * as we dont perform the shift operation to build io tag values so therefore
608 * need a way to incrment them correctly
610 #define scic_sds_io_sequence_increment(value) \
611 ((value) = (((value) + 1) & 0x000F))
613 /* expander attached sata devices require 3 rnc slots */
614 static inline int scic_sds_remote_device_node_count(struct scic_sds_remote_device
*sci_dev
)
616 struct domain_device
*dev
= sci_dev_to_domain(sci_dev
);
618 if ((dev
->dev_type
== SATA_DEV
|| (dev
->tproto
& SAS_PROTOCOL_STP
)) &&
619 !sci_dev
->is_direct_attached
)
620 return SCU_STP_REMOTE_NODE_COUNT
;
621 return SCU_SSP_REMOTE_NODE_COUNT
;
625 * scic_sds_controller_set_invalid_phy() -
627 * This macro will set the bit in the invalid phy mask for this controller
628 * object. This is used to control messages reported for invalid link up
631 #define scic_sds_controller_set_invalid_phy(controller, phy) \
632 ((controller)->invalid_phy_mask |= (1 << (phy)->phy_index))
635 * scic_sds_controller_clear_invalid_phy() -
637 * This macro will clear the bit in the invalid phy mask for this controller
638 * object. This is used to control messages reported for invalid link up
641 #define scic_sds_controller_clear_invalid_phy(controller, phy) \
642 ((controller)->invalid_phy_mask &= ~(1 << (phy)->phy_index))
644 static inline struct device
*scic_to_dev(struct scic_sds_controller
*scic
)
646 return &scic_to_ihost(scic
)->pdev
->dev
;
649 static inline struct device
*sciphy_to_dev(struct scic_sds_phy
*sci_phy
)
651 struct isci_phy
*iphy
= sci_phy_to_iphy(sci_phy
);
653 if (!iphy
|| !iphy
->isci_port
|| !iphy
->isci_port
->isci_host
)
656 return &iphy
->isci_port
->isci_host
->pdev
->dev
;
659 static inline struct device
*sciport_to_dev(struct scic_sds_port
*sci_port
)
661 struct isci_port
*iport
= sci_port_to_iport(sci_port
);
663 if (!iport
|| !iport
->isci_host
)
666 return &iport
->isci_host
->pdev
->dev
;
669 static inline struct device
*scirdev_to_dev(struct scic_sds_remote_device
*sci_dev
)
671 struct isci_remote_device
*idev
=
672 container_of(sci_dev
, typeof(*idev
), sci
);
674 if (!idev
|| !idev
->isci_port
|| !idev
->isci_port
->isci_host
)
677 return &idev
->isci_port
->isci_host
->pdev
->dev
;
686 extern int isci_si_rev
;
688 static inline bool is_a0(void)
690 return isci_si_rev
== ISCI_SI_REVA0
;
693 static inline bool is_a2(void)
695 return isci_si_rev
== ISCI_SI_REVA2
;
698 static inline bool is_b0(void)
700 return isci_si_rev
> ISCI_SI_REVA2
;
703 void scic_sds_controller_post_request(struct scic_sds_controller
*scic
,
705 void scic_sds_controller_release_frame(struct scic_sds_controller
*scic
,
707 void scic_sds_controller_copy_sata_response(void *response_buffer
,
710 enum sci_status
scic_sds_controller_allocate_remote_node_context(struct scic_sds_controller
*scic
,
711 struct scic_sds_remote_device
*sci_dev
,
713 void scic_sds_controller_free_remote_node_context(
714 struct scic_sds_controller
*scic
,
715 struct scic_sds_remote_device
*sci_dev
,
717 union scu_remote_node_context
*scic_sds_controller_get_remote_node_context_buffer(
718 struct scic_sds_controller
*scic
,
721 struct scic_sds_request
*scic_request_by_tag(struct scic_sds_controller
*scic
,
724 struct scu_task_context
*scic_sds_controller_get_task_context_buffer(
725 struct scic_sds_controller
*scic
,
728 void scic_sds_controller_power_control_queue_insert(
729 struct scic_sds_controller
*scic
,
730 struct scic_sds_phy
*sci_phy
);
732 void scic_sds_controller_power_control_queue_remove(
733 struct scic_sds_controller
*scic
,
734 struct scic_sds_phy
*sci_phy
);
736 void scic_sds_controller_link_up(
737 struct scic_sds_controller
*scic
,
738 struct scic_sds_port
*sci_port
,
739 struct scic_sds_phy
*sci_phy
);
741 void scic_sds_controller_link_down(
742 struct scic_sds_controller
*scic
,
743 struct scic_sds_port
*sci_port
,
744 struct scic_sds_phy
*sci_phy
);
746 void scic_sds_controller_remote_device_stopped(
747 struct scic_sds_controller
*scic
,
748 struct scic_sds_remote_device
*sci_dev
);
750 void scic_sds_controller_copy_task_context(
751 struct scic_sds_controller
*scic
,
752 struct scic_sds_request
*this_request
);
754 void scic_sds_controller_register_setup(struct scic_sds_controller
*scic
);
756 enum sci_status
scic_controller_continue_io(struct scic_sds_request
*sci_req
);
757 int isci_host_scan_finished(struct Scsi_Host
*, unsigned long);
758 void isci_host_scan_start(struct Scsi_Host
*);
760 int isci_host_init(struct isci_host
*);
762 void isci_host_init_controller_names(
763 struct isci_host
*isci_host
,
764 unsigned int controller_idx
);
766 void isci_host_deinit(
769 void isci_host_port_link_up(
771 struct scic_sds_port
*,
772 struct scic_sds_phy
*);
773 int isci_host_dev_found(struct domain_device
*);
775 void isci_host_remote_device_start_complete(
777 struct isci_remote_device
*,
780 void scic_controller_disable_interrupts(
781 struct scic_sds_controller
*scic
);
783 enum sci_status
scic_controller_start_io(
784 struct scic_sds_controller
*scic
,
785 struct scic_sds_remote_device
*remote_device
,
786 struct scic_sds_request
*io_request
,
789 enum sci_task_status
scic_controller_start_task(
790 struct scic_sds_controller
*scic
,
791 struct scic_sds_remote_device
*remote_device
,
792 struct scic_sds_request
*task_request
,
795 enum sci_status
scic_controller_terminate_request(
796 struct scic_sds_controller
*scic
,
797 struct scic_sds_remote_device
*remote_device
,
798 struct scic_sds_request
*request
);
800 enum sci_status
scic_controller_complete_io(
801 struct scic_sds_controller
*scic
,
802 struct scic_sds_remote_device
*remote_device
,
803 struct scic_sds_request
*io_request
);
805 u16
scic_controller_allocate_io_tag(
806 struct scic_sds_controller
*scic
);
808 enum sci_status
scic_controller_free_io_tag(
809 struct scic_sds_controller
*scic
,
812 void scic_sds_port_configuration_agent_construct(
813 struct scic_sds_port_configuration_agent
*port_agent
);
815 enum sci_status
scic_sds_port_configuration_agent_initialize(
816 struct scic_sds_controller
*controller
,
817 struct scic_sds_port_configuration_agent
*port_agent
);